pyrig Documentation

A Python toolkit to rig up your project that standardizes and automates project setup, configuration and development.

Philosophy

pyrig provides minimal best practices fully working defaults for everything a project needs. Every configuration, workflow, and tool is pre-configured and working from day one. No templates, no boilerplate - just a complete, tested, production-ready setup that lets you start coding immediately.

Architecture Overview

graph LR A[pyrig] --> B[CLI Commands] A --> C[Config Files] A --> D[Builders] A --> E[Tests & Fixtures] A --> F[CI/CD Workflows] B -.-> B1[init, mkroot, mktests, mkinits, build, protect-repo] C -.-> C1[auto-generated configuration files] D -.-> D1[PyInstaller & custom builders] E -.-> E1[Shared fixtures auto-discovery] F -.-> F1[health check, build, release, deploy] style A fill:#a8dadc,stroke:#333,stroke-width:2px,color:#000 style B fill:#f4a261,stroke:#333,stroke-width:2px,color:#000 style C fill:#f4a261,stroke:#333,stroke-width:2px,color:#000 style D fill:#f4a261,stroke:#333,stroke-width:2px,color:#000 style E fill:#f4a261,stroke:#333,stroke-width:2px,color:#000 style F fill:#f4a261,stroke:#333,stroke-width:2px,color:#000

Quick Start

# Create repository on GitHub, then clone it
git clone https://github.com/username/my-project.git
cd my-project

# Initialize with uv and pyrig
uv init
uv add pyrig
uv run pyrig init

# Push to GitHub
git push -u origin main

New to pyrig? See the Getting Started Guide for complete setup instructions including prerequisites, required tokens, and detailed explanations.

Documentation

CLI Documentation

Learn how pyrig's CLI system works, including command discovery, multi-package support, and how to create your own commands.

Testing Documentation

Understand pyrig's testing framework, including mirrored test structure, automatic fixture sharing, and autouse validation fixtures.

Builder Documentation

Create distributable artifacts with pyrig's builder system, including PyInstaller executables and custom build processes.

Resources Documentation

Manage static files (images, configs, templates) that work seamlessly in both development and PyInstaller executables.

Configuration Files Documentation

Understand pyrig's configuration file system, including automatic discovery, validation, and creating custom config files. This is the main feature of pyrig that generates a complete project structure for you, ready to use and start developing your project.