# realpython/python-guide architecture

> Architecture diagram of the GitHub repository realpython/python-guide, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-09). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/realpython/python-guide
- Repository: https://github.com/realpython/python-guide

## Overview

This repository is a documentation product: the Hitchhiker’s Guide to Python, an opinionated handbook for choosing, installing, configuring, and using Python tools. A reader starts with the guide, then explores installation and environment setup, practical scenarios, and writing or shipping Python projects. The README names these capabilities, while the tree shows their documentation areas. Source excerpts do not expose links or navigation among those areas, so the graph does not infer a sequence between them.

Main entry points: [`docs`](https://github.com/realpython/python-guide/tree/master/docs) (Best-practices guide), [`docs/starting`](https://github.com/realpython/python-guide/tree/master/docs/starting) (Installation), [`docs/dev`](https://github.com/realpython/python-guide/tree/master/docs/dev) (Virtual environments), [`docs/scenarios/admin.rst`](https://github.com/realpython/python-guide/blob/master/docs/scenarios/admin.rst) (Administration)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_guide["Guide entry"]
  node_guidebook["Best-practices guide"]
end

subgraph group_setup["Python setup"]
  node_install["Installation"]
  node_virtualenv["Virtual environments"]
end

subgraph group_scenarios["Usage scenarios"]
  node_admin["Administration<br/>[admin.rst]"]
  node_cli["Command line<br/>[cli.rst]"]
  node_client["Client development<br/>[client.rst]"]
  node_data["Data and science<br/>[scientific.rst]"]
  node_web["Web development<br/>[web.rst]"]
  node_network["Networking<br/>[network.rst]"]
  node_scraping["Web scraping<br/>[scrape.rst]"]
  node_serialization["Data formats<br/>[serialization.rst]"]
end

subgraph group_practice["Project practice"]
  node_testing["Testing and CI<br/>[ci.rst]"]
  node_documentation["Writing documentation"]
  node_packaging["Packaging and publishing"]
end

node_reader(("Python reader"))

node_reader -->|"reads"| node_guidebook
node_guidebook -->|"covers setup"| node_install
node_guidebook -->|"covers setup"| node_virtualenv
node_guidebook -->|"covers scenarios"| node_admin
node_guidebook -->|"covers scenarios"| node_cli
node_guidebook -->|"covers scenarios"| node_client
node_guidebook -->|"covers scenarios"| node_data
node_guidebook -->|"covers scenarios"| node_web
node_guidebook -->|"covers scenarios"| node_network
node_guidebook -->|"covers scenarios"| node_scraping
node_guidebook -->|"covers scenarios"| node_serialization
node_guidebook -->|"covers testing"| node_testing
node_guidebook -->|"covers writing"| node_documentation
node_guidebook -->|"covers shipping"| node_packaging

click node_guidebook "https://github.com/realpython/python-guide/tree/master/docs"
click node_install "https://github.com/realpython/python-guide/tree/master/docs/starting"
click node_virtualenv "https://github.com/realpython/python-guide/tree/master/docs/dev"
click node_admin "https://github.com/realpython/python-guide/blob/master/docs/scenarios/admin.rst"
click node_cli "https://github.com/realpython/python-guide/blob/master/docs/scenarios/cli.rst"
click node_client "https://github.com/realpython/python-guide/blob/master/docs/scenarios/client.rst"
click node_data "https://github.com/realpython/python-guide/blob/master/docs/scenarios/scientific.rst"
click node_web "https://github.com/realpython/python-guide/blob/master/docs/scenarios/web.rst"
click node_network "https://github.com/realpython/python-guide/blob/master/docs/scenarios/network.rst"
click node_scraping "https://github.com/realpython/python-guide/blob/master/docs/scenarios/scrape.rst"
click node_serialization "https://github.com/realpython/python-guide/blob/master/docs/scenarios/serialization.rst"
click node_testing "https://github.com/realpython/python-guide/blob/master/docs/scenarios/ci.rst"
click node_documentation "https://github.com/realpython/python-guide/tree/master/docs/writing"
click node_packaging "https://github.com/realpython/python-guide/tree/master/docs/shipping"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_guidebook toneBlue
class node_install,node_virtualenv toneAmber
class node_admin,node_cli,node_client,node_data,node_web,node_network,node_scraping,node_serialization toneMint
class node_testing,node_documentation,node_packaging toneRose
class node_reader toneIndigo
```

## Components

### Guide entry

- [Best-practices guide](https://github.com/realpython/python-guide/tree/master/docs): `docs`

### Python setup

- [Installation](https://github.com/realpython/python-guide/tree/master/docs/starting): `docs/starting`
- [Virtual environments](https://github.com/realpython/python-guide/tree/master/docs/dev): `docs/dev`

### Usage scenarios

- [Administration](https://github.com/realpython/python-guide/blob/master/docs/scenarios/admin.rst): `docs/scenarios/admin.rst`
- [Command line](https://github.com/realpython/python-guide/blob/master/docs/scenarios/cli.rst): `docs/scenarios/cli.rst`
- [Client development](https://github.com/realpython/python-guide/blob/master/docs/scenarios/client.rst): `docs/scenarios/client.rst`
- [Data and science](https://github.com/realpython/python-guide/blob/master/docs/scenarios/scientific.rst): `docs/scenarios/scientific.rst`
- [Web development](https://github.com/realpython/python-guide/blob/master/docs/scenarios/web.rst): `docs/scenarios/web.rst`
- [Networking](https://github.com/realpython/python-guide/blob/master/docs/scenarios/network.rst): `docs/scenarios/network.rst`
- [Web scraping](https://github.com/realpython/python-guide/blob/master/docs/scenarios/scrape.rst): `docs/scenarios/scrape.rst`
- [Data formats](https://github.com/realpython/python-guide/blob/master/docs/scenarios/serialization.rst): `docs/scenarios/serialization.rst`

### Project practice

- [Testing and CI](https://github.com/realpython/python-guide/blob/master/docs/scenarios/ci.rst): `docs/scenarios/ci.rst`
- [Writing documentation](https://github.com/realpython/python-guide/tree/master/docs/writing): `docs/writing`
- [Packaging and publishing](https://github.com/realpython/python-guide/tree/master/docs/shipping): `docs/shipping`

### Other components

- **Python reader**

## Connections

- Python reader → Best-practices guide: reads (evidence: `Readme.rst`)
- Best-practices guide → Installation: covers setup (evidence: `Readme.rst`)
- Best-practices guide → Virtual environments: covers setup (evidence: `Readme.rst`)
- Best-practices guide → Administration: covers scenarios (evidence: `Readme.rst`)
- Best-practices guide → Command line: covers scenarios (evidence: `Readme.rst`)
- Best-practices guide → Client development: covers scenarios (evidence: `Readme.rst`)
- Best-practices guide → Data and science: covers scenarios (evidence: `Readme.rst`)
- Best-practices guide → Web development: covers scenarios (evidence: `Readme.rst`)
- Best-practices guide → Networking: covers scenarios (evidence: `Readme.rst`)
- Best-practices guide → Web scraping: covers scenarios (evidence: `Readme.rst`)
- Best-practices guide → Data formats: covers scenarios (evidence: `Readme.rst`)
- Best-practices guide → Testing and CI: covers testing (evidence: `Readme.rst`)
- Best-practices guide → Writing documentation: covers writing (evidence: `Readme.rst`)
- Best-practices guide → Packaging and publishing: covers shipping (evidence: `Readme.rst`)
