pyrig 4.0.5

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

pyrig

---

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

---

What is pyrig?

pyrig is an opinionated Python project toolkit that eliminates setup time and enforces best practices. Run one command to get a complete, production-ready project structure with CI/CD, testing, documentation, and more.

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, so you can focus on writing code and start immediately developing your application, project or library.

Key Features

Zero Configuration Setup:

• Complete project structure in minutes
• Pre-configured tools (uv, ruff, ty, pytest, MkDocs)
• GitHub Actions workflows (health check, build, release, publish)
• 90% test coverage enforcement
• Pre-commit hooks with all quality checks

Automated Project Management:

• CLI framework with automatic command discovery
• Configuration file system with validation
• Automatic test skeleton generation
• PyInstaller executable building
• Multi-package architecture support

Opinionated Best Practices:

• Python >=3.12 with modern type hints
• All ruff linting rules enabled
• Strict type checking with ty
• Signed commits and linear history
• Repository protection rules

Quick Example

# Create repository on GitHub
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

# Complete project ready in minutes:
# ✓ Source code structure
# ✓ Test framework with 90% coverage
# ✓ CI/CD workflows
# ✓ Documentation site
# ✓ Pre-commit hooks
# ✓ Container support

What You Get

After running uv run pyrig init, you get a complete project with:

• Complete directory structure with source code, tests, docs, and CI/CD
• Pre-configured tools (uv, ruff, ty, pytest, MkDocs, Podman)
• GitHub Actions workflows (health check, build, release, publish)
• 90% test coverage enforcement
• Pre-commit hooks with all quality checks

See the Getting Started Guide for the complete project structure and detailed setup instructions.

CLI Commands

uv run pyrig init        # Complete project initialization
uv run pyrig mkroot      # Update project structure
uv run pyrig mktests     # Generate test skeletons
uv run pyrig build       # Build all artifacts
uv run my-project --help # Your custom CLI

Quick Start

New to pyrig? Start here:

• Getting Started Guide
• Complete setup from zero to fully configured project

Full Documentation - Comprehensive documentation on GitHub Pages

CodeWiki Documentation - AI-generated documentation

---