pyrig 3.0.9__tar.gz → 4.2.3__tar.gz

{pyrig-3.0.9 → pyrig-4.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyrig
-Version: 3.0.9
+Version: 4.2.3
 Summary: A Python toolkit to rig up your project that standardizes and automates project setup, configuration and development.
 Keywords: project-setup,automation,scaffolding,cli,testing,ci-cd,devops,packaging
 Author: Winipedia
@@ -8,16 +8,16 @@ License-Expression: MIT
 License-File: LICENSE
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Classifier: Operating System :: OS Independent
 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.20.0
 Maintainer: Winipedia
@@ -39,10 +39,11 @@ Description-Content-Type: text/markdown
 [![MkDocs](https://img.shields.io/badge/MkDocs-Documentation-326CE5?logo=mkdocs&logoColor=white)](https://www.mkdocs.org/)
 <!-- code-quality -->
 [![ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
-[![ty](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json)](https://github.com/astral-sh/ty)[![mypy](https://img.shields.io/badge/type%20checked-mypy-039dfc.svg)](https://mypy-lang.org/)
+[![ty](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json)](https://github.com/astral-sh/ty)
 [![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)
 [![pytest](https://img.shields.io/badge/tested%20with-pytest-46a2f1.svg?logo=pytest)](https://pytest.org/)
 [![codecov](https://codecov.io/gh/Winipedia/pyrig/branch/main/graph/badge.svg)](https://codecov.io/gh/Winipedia/pyrig)
+[![rumdl](https://img.shields.io/badge/markdown-rumdl-darkgreen)](https://github.com/rvben/rumdl)
 <!-- package-info -->
 [![PyPI](https://img.shields.io/pypi/v/pyrig?logo=pypi&logoColor=white)](https://pypi.org/project/pyrig)
 [![Python](https://img.shields.io/badge/python-3.12|3.13|3.14-blue.svg?logo=python&logoColor=white)](https://www.python.org/)
@@ -61,20 +62,29 @@ Description-Content-Type: text/markdown
 
 ## 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.
+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.
+**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, mypy, pytest, MkDocs)
+- 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
@@ -82,9 +92,10 @@ pyrig is an opinionated Python project toolkit that eliminates setup time and en
 - Multi-package architecture support
 
 **Opinionated Best Practices**:
+
 - Python >=3.12 with modern type hints
 - All ruff linting rules enabled
-- Strict mypy type checking
+- Strict type checking with ty
 - Signed commits and linear history
 - Repository protection rules
 
@@ -111,92 +122,17 @@ uv run pyrig init
 
 ### What You Get
 
-**Complete Project Structure**:
-```
-my-project/
-├── my_project/                      # Source code package
-│   ├── __init__.py
-│   ├── main.py                      # CLI entry point
-│   ├── py.typed                     # PEP 561 type marker
-│   ├── dev/                         # Development infrastructure
-│   │   ├── __init__.py
-│   │   ├── builders/                # Build artifact definitions
-│   │   │   ├── __init__.py
-│   │   ├── cli/                     # CLI command system
-│   │   │   ├── __init__.py
-│   │   │   ├── subcommands.py       # Project commands
-│   │   │   ├── shared_subcommands.py # Shared commands
-│   │   ├── configs/                 # Config file managers
-│   │   │   ├── __init__.py
-│   │   ├── tests/                   # Test infrastructure
-│   │   │   ├── __init__.py
-│   │   │   └── fixtures/
-│   │   │       └── __init__.py
-│   ├── resources/                   # Static resources
-│   │   └── __init__.py
-│   └── src/                         # Application logic
-│       └── __init__.py
-│
-├── tests/                           # Test files (mirrors source)
-│   ├── __init__.py
-│   ├── conftest.py                  # Pytest configuration
-│   ├── test_zero.py                 # Initial test
-│   └── test_my_project/             # Mirrors my_project/ structure
-│       ├── __init__.py
-│       ├── test_main.py
-│       ├── test_dev/                # Mirrors my_project/dev/
-│       │   ├── __init__.py
-│       │   ├── test_builders/
-│       │   │   └── __init__.py
-│       │   ├── test_cli/
-│       │   │   ├── __init__.py
-│       │   │   ├── test_subcommands.py
-│       │   │   └── test_shared_subcommands.py
-│       │   ├── test_configs/
-│       │   │   └── __init__.py
-│       │   └── test_tests/
-│       │       └── __init__.py
-│       ├── test_resources/          # Mirrors my_project/resources/
-│       │   └── __init__.py
-│       └── test_src/                # Mirrors my_project/src/
-│           └── __init__.py
-│
-├── docs/                            # MkDocs documentation
-│   └── index.md                     # Documentation homepage
-│
-├── .github/                         # GitHub configuration
-│   └── workflows/                   # CI/CD workflows
-│       ├── health_check.yaml        # Tests, linting, type checking
-│       ├── build.yaml               # Build artifacts
-│       ├── release.yaml             # Version and release
-│       └── publish.yaml             # PyPI and docs publishing
-│
-├── .env                             # Environment variables (not committed)
-├── .experiment.py                   # Scratch file for local experiments (not committed)
-├── .gitignore                       # Git ignore patterns
-├── .pre-commit-config.yaml          # Pre-commit hooks
-├── .python-version                  # Python version (3.12+)
-├── Containerfile                    # Podman/Docker image definition
-├── LICENSE                          # MIT license
-├── README.md                        # Project readme
-├── mkdocs.yml                       # MkDocs configuration
-├── pyproject.toml                   # Project metadata and tool configs
-└── uv.lock                          # Dependency lock file
-```
+After running `uv run pyrig init`, you get a complete project with:
 
-**CI/CD Workflows**:
-- **Health Check** - Tests, linting, type checking on every PR
-- **Build** - Creates executables and container images
-- **Release** - Automated version bumping and GitHub releases
-- **Publish** - PyPI and GitHub Pages deployment
+- **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
 
-**Development Tools**:
-- **uv** - Fast package management (10-100x faster than pip)
-- **ruff** - Linting and formatting (all rules enabled)
-- **mypy** - Static type checking (strict mode)
-- **pytest** - Testing with coverage reporting
-- **MkDocs** - Documentation generation
-- **Podman** - Container support
+See the
+[Getting Started Guide](https://winipedia.github.io/pyrig/more/getting-started/)
+for the complete project structure and detailed setup instructions.
 
 ### CLI Commands
 
@@ -212,8 +148,11 @@ uv run my-project --help # Your custom CLI
 
 New to pyrig? Start here:
 
-**[Getting Started Guide](https://winipedia.github.io/pyrig/more/getting-started/)** - Complete setup from zero to fully configured project
+- *[Getting Started Guide](https://winipedia.github.io/pyrig/more/getting-started/)*
+- Complete setup from zero to fully configured project
 
 **[Full Documentation](https://winipedia.github.io/pyrig/)** - Comprehensive documentation on GitHub Pages
 
+**[CodeWiki Documentation](https://codewiki.google/github.com/winipedia/pyrig)** - AI-generated documentation
+
 ---

pyrig-4.2.3/README.md

@@ -0,0 +1,127 @@
+# pyrig
+
+<!-- tooling -->
+[![pyrig](https://img.shields.io/badge/built%20with-pyrig-3776AB?logo=buildkite&logoColor=black)](https://github.com/Winipedia/pyrig)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![Container](https://img.shields.io/badge/Container-Podman-A23CD6?logo=podman&logoColor=grey&colorA=0D1F3F&colorB=A23CD6)](https://podman.io/)
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://pre-commit.com/)
+[![MkDocs](https://img.shields.io/badge/MkDocs-Documentation-326CE5?logo=mkdocs&logoColor=white)](https://www.mkdocs.org/)
+<!-- code-quality -->
+[![ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![ty](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json)](https://github.com/astral-sh/ty)
+[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)
+[![pytest](https://img.shields.io/badge/tested%20with-pytest-46a2f1.svg?logo=pytest)](https://pytest.org/)
+[![codecov](https://codecov.io/gh/Winipedia/pyrig/branch/main/graph/badge.svg)](https://codecov.io/gh/Winipedia/pyrig)
+[![rumdl](https://img.shields.io/badge/markdown-rumdl-darkgreen)](https://github.com/rvben/rumdl)
+<!-- package-info -->
+[![PyPI](https://img.shields.io/pypi/v/pyrig?logo=pypi&logoColor=white)](https://pypi.org/project/pyrig)
+[![Python](https://img.shields.io/badge/python-3.12|3.13|3.14-blue.svg?logo=python&logoColor=white)](https://www.python.org/)
+[![License](https://img.shields.io/github/license/Winipedia/pyrig)](https://github.com/Winipedia/pyrig/blob/main/LICENSE)
+<!-- ci/cd -->
+[![CI](https://img.shields.io/github/actions/workflow/status/Winipedia/pyrig/health_check.yaml?label=CI&logo=github)](https://github.com/Winipedia/pyrig/actions/workflows/health_check.yaml)
+[![CD](https://img.shields.io/github/actions/workflow/status/Winipedia/pyrig/release.yaml?label=CD&logo=github)](https://github.com/Winipedia/pyrig/actions/workflows/release.yaml)
+<!-- documentation -->
+[![Documentation](https://img.shields.io/badge/Docs-GitHub%20Pages-black?style=for-the-badge&logo=github&logoColor=white)](https://Winipedia.github.io/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
+
+```bash
+# 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](https://winipedia.github.io/pyrig/more/getting-started/)
+for the complete project structure and detailed setup instructions.
+
+### CLI Commands
+
+```bash
+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](https://winipedia.github.io/pyrig/more/getting-started/)*
+- Complete setup from zero to fully configured project
+
+**[Full Documentation](https://winipedia.github.io/pyrig/)** - Comprehensive documentation on GitHub Pages
+
+**[CodeWiki Documentation](https://codewiki.google/github.com/winipedia/pyrig)** - AI-generated documentation
+
+---

{pyrig-3.0.9 → pyrig-4.2.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pyrig"
-version = "3.0.9"
+version = "4.2.3"
 description = "A Python toolkit to rig up your project that standardizes and automates project setup, configuration and development."
 authors = [
     {name = "Winipedia"},
@@ -20,16 +20,16 @@ dependencies = [
 classifiers = [
     "Development Status :: 5 - Production/Stable",
     "Intended Audience :: Developers",
-    "Programming Language :: Python :: 3.12",
-    "Programming Language :: Python :: 3.13",
-    "Programming Language :: Python :: 3.14",
-    "Operating System :: OS Independent",
     "Topic :: Software Development :: Build Tools",
     "Topic :: Software Development :: Libraries :: Python Modules",
     "Topic :: Software Development :: Quality Assurance",
     "Topic :: Software Development :: Testing",
     "Topic :: System :: Installation/Setup",
     "Topic :: System :: Software Distribution",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Operating System :: OS Independent",
     "Typing :: Typed",
 ]
 keywords = [
@@ -71,7 +71,6 @@ module-root = ""
 [tool.ruff]
 exclude = [
     ".*",
-    "**/migrations/*.py",
 ]
 
 [tool.ruff.lint]
@@ -99,12 +98,6 @@ convention = "google"
 [tool.ty.terminal]
 error-on-warning = true
 
-[tool.mypy]
-strict = true
-warn_unreachable = true
-show_error_codes = true
-files = "."
-
 [tool.pytest.ini_options]
 addopts = "--cov=pyrig --cov-report=term-missing --cov-fail-under=90"
 testpaths = [
@@ -120,3 +113,6 @@ exclude_dirs = [
 skips = [
     "*/tests/*.py",
 ]
+
+[tool.rumdl]
+respect_gitignore = true

pyrig-4.2.3/pyrig/__init__.py

@@ -0,0 +1,18 @@
+"""pyrig - A Python toolkit to rig up your project.
+
+Opinionated Python project toolkit that standardizes and automates project setup,
+configuration, and development.
+
+Subpackages:
+    src: Runtime utilities available in production environments.
+        Includes project name extraction (cli), Git utilities (git),
+        directed graph (graph), nested structure validation (iterate),
+        resource access (resource), string manipulation (string),
+        module introspection (modules), and subprocess execution (processes).
+    dev: Development-time tools requiring dev dependencies.
+        Includes artifact builders (builders), CLI framework and commands (cli),
+        configuration file system (configs), tool wrappers (management),
+        test infrastructure (tests), and development utilities (utils).
+    resources: Static resource files (templates, licenses, data files).
+        Accessible via get_resource_path(name, package) from pyrig.src.resource.
+"""

pyrig-4.2.3/pyrig/dev/__init__.py

@@ -0,0 +1,15 @@
+"""Development-time infrastructure for pyrig projects.
+
+Provides development tools, configuration management, CLI commands, artifact builders,
+and testing infrastructure. For development and CI/CD only, not runtime use.
+
+Subpackages:
+    builders: Artifact building (PyInstaller executables, distributions)
+    cli: Command-line interface and subcommands
+    configs: Configuration file generators and managers
+    tests: Testing infrastructure and pytest fixtures
+    utils: Development utilities and helpers
+
+Note:
+    Development dependencies only. Not for production runtime code.
+"""

pyrig-4.2.3/pyrig/dev/builders/__init__.py

@@ -0,0 +1,5 @@
+"""Custom artifact builders for creating distributable packages.
+
+Add custom BuilderConfigFile subclasses here to create project-specific artifacts.
+Builders are automatically discovered and executed when running `pyrig build`.
+"""

pyrig-4.2.3/pyrig/dev/builders/base/__init__.py

@@ -0,0 +1,15 @@
+"""Base classes for artifact builders.
+
+Provides the abstract `BuilderConfigFile` base class that defines the interface
+and orchestration logic for all artifact builders. The BuilderConfigFile class
+handles the complete build lifecycle including temporary directory management,
+artifact creation, platform-specific renaming, and automatic cleanup.
+
+Classes:
+    BuilderConfigFile: Abstract base class for artifact builders. Subclasses
+        must implement `create_artifacts(cls, temp_artifacts_dir: Path) -> None`.
+
+See Also:
+    pyrig.dev.builders.base.base.BuilderConfigFile: Full class implementation
+    pyrig.dev.builders.pyinstaller.PyInstallerBuilder: PyInstaller builder
+"""