Metadata-Version: 2.4
Name: pyrig
Version: 11.4.14
Summary: pyrig is a python toolkit that rigs up your project by standardizing and automating project setup, configuration and maintenance
Keywords: project-setup,automation,scaffolding,cli,testing,ci-cd,devops,packaging
Author: Winipedia
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: System :: Installation/Setup
Classifier: Topic :: System :: Software Distribution
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Operating System :: OS Independent
Classifier: Typing :: Typed
Requires-Dist: typer>=0.21.1
Maintainer: Winipedia
Requires-Python: >=3.12
Project-URL: Homepage, https://github.com/Winipedia/pyrig
Project-URL: Documentation, https://Winipedia.github.io/pyrig
Project-URL: Source, https://github.com/Winipedia/pyrig
Project-URL: Issues, https://github.com/Winipedia/pyrig/issues
Project-URL: Changelog, https://github.com/Winipedia/pyrig/releases
Description-Content-Type: text/markdown

# pyrig

<!-- security -->
[![SecurityChecker](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)
[![DependencyAuditor](https://img.shields.io/badge/security-pip--audit-blue?logo=python)](https://github.com/pypa/pip-audit)
<!-- tooling -->
[![VersionController](https://img.shields.io/badge/Git-F05032?logo=git&logoColor=white)](https://git-scm.com)
[![RemoteVersionController](https://img.shields.io/github/stars/Winipedia/pyrig?style=social)](https://github.com/Winipedia/pyrig)
[![ContainerEngine](https://img.shields.io/badge/Container-Podman-A23CD6?logo=podman&logoColor=grey&colorA=0D1F3F&colorB=A23CD6)](https://podman.io)
[![Pyrigger](https://img.shields.io/badge/built%20with-pyrig-3776AB?logo=buildkite&logoColor=black)](https://github.com/Winipedia/pyrig)
[![PackageManager](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
<!-- documentation -->
[![DocsBuilder](https://img.shields.io/badge/MkDocs-Documentation-326CE5?logo=mkdocs&logoColor=white)](https://www.mkdocs.org)
[![Documentation](https://img.shields.io/badge/Docs-GitHub%20Pages-black?style=for-the-badge&logo=github&logoColor=white)](https://Winipedia.github.io/pyrig)
<!-- code-quality -->
[![VersionControlHookManager](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/j178/prek/master/docs/assets/badge-v0.json)](https://github.com/j178/prek)
[![PythonLinter](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![MarkdownLinter](https://img.shields.io/badge/markdown-rumdl-darkgreen)](https://github.com/rvben/rumdl)
[![TypeChecker](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json)](https://github.com/astral-sh/ty)
<!-- project-info -->
[![PackageIndex](https://img.shields.io/pypi/v/pyrig?logo=pypi&logoColor=white)](https://pypi.org/project/pyrig)
[![ProgrammingLanguage](https://img.shields.io/pypi/pyversions/pyrig)](https://www.python.org)
[![License](https://img.shields.io/github/license/Winipedia/pyrig)](https://github.com/Winipedia/pyrig/blob/main/LICENSE)
<!-- testing -->
[![ProjectTester](https://img.shields.io/badge/tested%20with-pytest-46a2f1.svg?logo=pytest)](https://pytest.org)
[![ProjectCoverageTester](https://codecov.io/gh/Winipedia/pyrig/branch/main/graph/badge.svg)](https://codecov.io/gh/Winipedia/pyrig)
<!-- ci/cd -->
[![CI](https://img.shields.io/github/actions/workflow/status/Winipedia/pyrig/health_check.yml?label=CI&logo=github)](https://github.com/Winipedia/pyrig/actions/workflows/health_check.yml)
[![CD](https://img.shields.io/github/actions/workflow/status/Winipedia/pyrig/release.yml?label=CD&logo=github)](https://github.com/Winipedia/pyrig/actions/workflows/release.yml)

<!-- rumdl-disable MD013 -->
---

> pyrig is a python toolkit that rigs up your project by standardizing and automating project setup, configuration and maintenance

---

<!-- rumdl-enable MD013 -->

## What is pyrig?

pyrig is a package and tool that scaffolds and initializes a complete, fully
configured and working python project with one command and makes the process of
developing and maintaining more seemless and efficient by automating things like
configuration management, CLI generation, testing infrastructure, and more.

## Requirements

- Python 3.12+
- Git
- uv

## Quick Start

```bash
uv init
uv add pyrig
uv run pyrig init
```

See the
[Getting Started Guide](https://winipedia.github.io/pyrig/getting-started/)
for detailed setup instructions to also fully integrate with GitHub and
CI/CD from the start.

## Features

### Project Scaffolding & Initialization

`pyrig init` generates a complete project in one command that works out of the box.
This includes everything a modern python project needs:

- Standardized directory structure
- Fully configured dev tools
(PythonLinters, formatters, type checkers, test frameworks, etc.)
- GitHub Actions workflows for CI/CD
- Repository management configs (branch protection, issue/PR templates, etc.)
- A working CLI

### File & Configuration Management

Every generated file is backed by a Python class that validates and merges
automatically. Override any config by subclassing, or define entirely new
config files — pyrig discovers and manages them for you.
Run `pyrig mkroot` to create or update all config files at once.
Run `pyrig subcls` to generate a subclass for overriding a specific config.

### Automatic CLI

`pyrig init` sets up a CLI for your project that works immediately.
Generate and add new commands by running `pyrig mkcmd <command-name>`.
An automatic version command is included that shows the version of your project.
Run `my-project version` to see it in action.

### Test Generation

Generate test skeletons with `pyrig mktests`.
This will generate test skeletons for all source modules
and update them automatically as your project evolves.

### Test Fixtures

pyrig enables automatic sharing and registration of pytest fixtures.
Run `pyrig mkfixture <fixture-name>` to generate a new fixture that is
automatically registered and available across all your tests.

### Build Artifacts

PyInstaller integration and extensible build system for generating executables,
distributable packages, and more.
Run `pyrig subcls` to create a custom builder for your specific build needs.
Run `pyrig build` to execute the build process and generate artifacts.
Run `pyrig resources` to create a resources directory for your project.

### Multi-Package Inheritance

Override and customize any and all behaviour to suit your project's needs.
pyrig's classes are designed for inheritance and composition, allowing you to
create custom configurations, tools, builders, and more by subclassing and simply
overriding methods. pyrig will automatically discover and use your custom classes
without any additional configuration.
Run `pyrig subcls` to generate a subclass for any pyrig class.

### CI/CD & Repository Protection

Pyrig generates GitHub Actions workflows for CI/CD and automatically configures
and applies repository protection settings and branch protection rules to ensure
your repository is protected.
Run `pyrig protect-repo` to apply or update repository protection settings or
simply use the fully working CI/CD pipeline to apply them automatically.

## Pyrig Commands

```bash
uv run pyrig init           # Full project initialization
uv run pyrig mkroot         # Create/update all concrete config files
uv run pyrig mktests        # Generate test skeletons
uv run pyrig mkinits        # Create missing __init__.py files
uv run pyrig mkfixture      # Generate a new pytest fixture
uv run pyrig subcls         # Generate a subclass for overriding a config or tool
uv run pyrig build          # Build artifacts (PyInstaller, etc.)
uv run pyrig protect-repo   # Configure repository protection
uv run pyrig scratch        # Execute the project's .scratch file
uv run pyrig rmpyc          # Remove __pycache__ directories
uv run pyrig version        # Show pyrig version
uv run my-project --help    # Your project's CLI
uv run my-project version   # Show your project's version
```

## Documentation

| | |
|---|---|
| **[Full Documentation](https://winipedia.github.io/pyrig/)** | The manually written documentation |
| **[CodeWiki](https://codewiki.google/github.com/winipedia/pyrig)** | AI-generated documentation |
| **[Tutorials](https://www.youtube.com/@Winipedia-py/playlists)** | YouTube tutorials for pyrig |
