pyrig Documentation
Pyrig is a toolkit that standardizes and automates Python project setup, configuration, development, and maintenance.
Philosophy
pyrig provides minimal best practices fully working defaults for everything a python project needs. Every configuration, workflow, and tool is pre-configured and working from the start. No templates, no boilerplate - just a complete, tested, production-ready setup that lets you start developing code immediately.
More Detailed Documentation
We are keeping the manual documentation restricted to the essentials, if you want to know more about how pyrig works under the hood or you have more specific questions about how to use it than we explain here, check out the CodeWiki for AI-generated documentation about pyrig's codebase, where you can also ask questions and get code explanations from the AI.
Architecture Overview
For a high-level description of how pyrig works and some of its key features and capabilities, see the Architecture Overview.
Getting Started
To get started with pyrig, check out the Getting Started Guide for a complete walkthrough of setting up a new python project from scratch with pyrig.
Scaffolding
To see the full file tree of a project scaffolded by pyrig and get detailed descriptions of each file and configuration, see the Scaffolding Documentation.
Config File System
pyrig's config file system is built around the ConfigFile base class, which defines
how pyrig creates and validates files.
See the Config File System Documentation for details.
CLI System
pyrig provides a fully functional, inheritable and automatically extensible CLI that every project built on pyrig gets automatically. Check out the CLI System Documentation for more information.
Mirror Test System
pyrig provides a system for automatically generating and maintaining test files that mirror the structure of the source code and ensure everything is tested. Find out more about it in the Mirror Test System Documentation.
Test Fixture System
pyrig provides a system for automatically sharing and registering pytest fixtures across all your tests. See the Test Fixture System Documentation for more information.
CI/CD Pipeline
pyrig provides a complete end-to-end CI/CD pipeline with GitHub Actions and integrated repository protection. See the CI/CD Pipeline Documentation for a walkthrough of how it works and how to customize it.