Modern Python Project Guide

This guide explains how to build a small, maintainable Python project with modern tools and a pull-request-based workflow.

The same Markdown files remain readable directly on GitHub. MkDocs adds site navigation, search, and a local preview without replacing the repository README. Reviewed changes are published here from the protected main branch.

Choose your path

• Create a new project: follow the uv quickstart.
• Run this repository locally: follow the clone and CI quickstart.
• Learn the complete workflow: start with Why This Guide Exists and continue through the main learning path in the site navigation.
• Find a command or solve a problem: use the command cheatsheet, troubleshooting guide, or glossary in the reference section.

What the site adds

The generated site provides:

• navigation across the complete guide,
• full-text search,
• a consistent reading layout,
• strict build validation in continuous integration,
• automatic publication after relevant changes reach main.

Building and publishing remain separate operations with different permissions.

Start learning

Continue to Why This Guide Exists.