# egorhowell/medium-articles architecture

> Architecture diagram of the GitHub repository egorhowell/medium-articles, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/egorhowell/medium-articles
- Repository: https://github.com/egorhowell/medium-articles

## Overview

##### Project type and purpose
- This is a modular “educational code” repository supporting a Medium blog and YouTube channel.
- It contains self-contained tutorials and examples (notebooks and scripts) across seven topical areas.

##### Main components
A. Content Modules (seven topic folders)
- Data Science Basics
- Modelling
- Neural Networks
- Optimisation
- Software Engineering
- Statistics
- Time Series
B. Infrastructure & Tooling
- Version control & hooks: .gitignore, .pre-commit-config.yaml, pyproject.toml
- Build & orchestration: Makefile
- Packaging/config examples:
– Docker (Software Engineering/docker-example)
– Dynaconf (Software Engineering/dynaconf-example)
- Testing examples: pytest-example, code-quality examples (black, flake8, mypy, pytest)
C. External Platforms
- Medium blog
- YouTube channel

##### Relationships & data flows
1. User/Contributor clones the Git repo
2. Pre-commit hooks and Makefile targets run linting, formatting, tests
3. Once infra checks pass, the user opens/runs notebooks or scripts in each Content Module
4. Docker and Dynaconf examples show how to containerize or configure code
5. Tutorial outputs feed back to the blog/YouTube (publication pipeline)

##### Architectural patterns & design principles
- Modular separation by topic (“single-responsibility” folders)
- Infrastructure-as-code (Makefile & built-in CI hooks drive automation)
- Example-first approach: each folder is a self-contained demonstration or tutorial

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Top layer
    subgraph "User / Contributor"
        User["User / Contributor"]
    end

    User -->|"clone"| Repo["Git Repository"]

    %% Infrastructure & Tooling
    subgraph "Infrastructure & Tooling"
        GC[".gitignore"]:::infra
        PC[".pre-commit-config.yaml"]:::infra
        PP["pyproject.toml"]:::infra
        MF["Makefile"]:::infra
        DO["Docker Example"]:::infra
        DY["Dynaconf Example"]:::infra
        CQ["Code Quality Examples"]:::infra
        TE["Testing Examples"]:::infra
    end

    Repo --> GC
    Repo --> PC
    Repo --> PP
    Repo --> MF
    MF -->|"hooks & targets"| GC
    PC -->|"pre-commit hooks"| MF
    MF -->|"run lint/test"| CQ
    MF -->|"run pytest"| TE
    MF -->|"build container"| DO
    MF -->|"load config"| DY

    %% Shared Dependencies
    subgraph "Shared Dependencies"
        Dep["pandas, scikit-learn,\npymc3, hyperopt"]:::deps
    end

    %% Content Modules
    subgraph "Content Modules"
        DSB["Data Science Basics\n(.ipynb, Python, C)"]:::content
        MOD["Modelling\n(Python)"]:::content
        NN["Neural Networks\n(Python, numpy, TF/PyTorch)"]:::content
        OPT["Optimisation\n(Python, Fortran)"]:::content
        SE["Software Engineering\n(Docker, Dynaconf)"]:::content
        ST["Statistics\n(Python, Jupyter, pymc3)"]:::content
        TS["Time Series\n(Python, Jupyter)"]:::content
    end

    MF -->|"run notebooks/scripts"| DSB
    MF --> MOD
    MF --> NN
    MF --> OPT
    MF --> SE
    MF --> ST
    MF --> TS

    Dep --> DSB
    Dep --> MOD
    Dep --> NN
    Dep --> OPT
    Dep --> SE
    Dep --> ST
    Dep --> TS

    %% External Platforms
    Medium["Medium Blog"]:::external
    YouTube["YouTube Channel"]:::external

    DSB -->|"publish"| Medium
    MOD --> Medium
    NN --> Medium
    OPT --> Medium
    SE --> Medium
    ST --> Medium
    TS --> Medium

    DSB --> YouTube
    MOD --> YouTube
    NN --> YouTube
    OPT --> YouTube
    SE --> YouTube
    ST --> YouTube
    TS --> YouTube

    %% Click Events
    click DSB "https://github.com/egorhowell/medium-articles/tree/main/Data Science Basics/"
    click MOD "https://github.com/egorhowell/medium-articles/tree/main/Modelling/"
    click NN "https://github.com/egorhowell/medium-articles/tree/main/Neural Networks/"
    click OPT "https://github.com/egorhowell/medium-articles/tree/main/Optimisation/"
    click ST "https://github.com/egorhowell/medium-articles/tree/main/Statistics/"
    click TS "https://github.com/egorhowell/medium-articles/tree/main/Time Series/"
    click SE "https://github.com/egorhowell/medium-articles/tree/main/Software Engineering/"
    click GC "https://github.com/egorhowell/medium-articles/blob/main/.gitignore"
    click PC "https://github.com/egorhowell/medium-articles/blob/main/.pre-commit-config.yaml"
    click PP "https://github.com/egorhowell/medium-articles/blob/main/pyproject.toml"
    click MF "https://github.com/egorhowell/medium-articles/tree/main/Makefile"
    click DO "https://github.com/egorhowell/medium-articles/tree/main/Software Engineering/docker-example/Dockerfile"
    click DY "https://github.com/egorhowell/medium-articles/blob/main/Software Engineering/dynaconf-example/settings.toml"
    click CQ "https://github.com/egorhowell/medium-articles/blob/main/Software Engineering/code-quality-example/black_example.py"
    click TE "https://github.com/egorhowell/medium-articles/blob/main/Software Engineering/pytest-example/calculations.py"

    %% Styles
    classDef content fill:#ADD8E6,stroke:#333,stroke-width:1px
    classDef infra fill:#90EE90,stroke:#333,stroke-width:1px
    classDef external fill:#FFA500,stroke:#333,stroke-width:1px
    classDef deps fill:#D3D3D3,stroke:#333,stroke-width:1px
```
