pyrig 2.0.30__tar.gz → 3.0.9__tar.gz

{pyrig-2.0.30 → pyrig-3.0.9}/LICENSE

@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

pyrig-3.0.9/PKG-INFO

@@ -0,0 +1,219 @@
+Metadata-Version: 2.4
+Name: pyrig
+Version: 3.0.9
+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
+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: Typing :: Typed
+Requires-Dist: typer>=0.20.0
+Maintainer: Winipedia
+Requires-Python: >=3.12
+Project-URL: Changelog, https://github.com/Winipedia/pyrig/releases
+Project-URL: Documentation, https://Winipedia.github.io/pyrig
+Project-URL: Homepage, https://github.com/Winipedia/pyrig
+Project-URL: Issues, https://github.com/Winipedia/pyrig/issues
+Project-URL: Source, https://github.com/Winipedia/pyrig
+Description-Content-Type: text/markdown
+
+# 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)[![mypy](https://img.shields.io/badge/type%20checked-mypy-039dfc.svg)](https://mypy-lang.org/)
+[![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)
+<!-- 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, mypy, 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 mypy type checking
+- 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
+
+**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
+```
+
+**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
+
+**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
+
+### 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
+
+---

pyrig-3.0.9/README.md

@@ -0,0 +1,188 @@
+# 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)[![mypy](https://img.shields.io/badge/type%20checked-mypy-039dfc.svg)](https://mypy-lang.org/)
+[![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)
+<!-- 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, mypy, 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 mypy type checking
+- 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
+
+**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
+```
+
+**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
+
+**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
+
+### 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
+
+---

pyrig-3.0.9/pyproject.toml

@@ -0,0 +1,122 @@
+[project]
+name = "pyrig"
+version = "3.0.9"
+description = "A Python toolkit to rig up your project that standardizes and automates project setup, configuration and development."
+authors = [
+    {name = "Winipedia"},
+]
+maintainers = [
+    {name = "Winipedia"},
+]
+license = "MIT"
+license-files = [
+    "LICENSE",
+]
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = [
+    "typer>=0.20.0",
+]
+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",
+    "Typing :: Typed",
+]
+keywords = [
+    "project-setup",
+    "automation",
+    "scaffolding",
+    "cli",
+    "testing",
+    "ci-cd",
+    "devops",
+    "packaging",
+]
+
+[project.urls]
+Homepage = "https://github.com/Winipedia/pyrig"
+Documentation = "https://Winipedia.github.io/pyrig"
+Source = "https://github.com/Winipedia/pyrig"
+Issues = "https://github.com/Winipedia/pyrig/issues"
+Changelog = "https://github.com/Winipedia/pyrig/releases"
+
+[project.scripts]
+pyrig = "pyrig.dev.cli.cli:main"
+
+[dependency-groups]
+dev = [
+    "pyrig-dev>=0.1.1",
+]
+
+[build-system]
+requires = [
+    "uv_build",
+]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "pyrig"
+module-root = ""
+
+[tool.ruff]
+exclude = [
+    ".*",
+    "**/migrations/*.py",
+]
+
+[tool.ruff.lint]
+select = [
+    "ALL",
+]
+ignore = [
+    "D203",
+    "D213",
+    "COM812",
+    "ANN401",
+]
+fixable = [
+    "ALL",
+]
+
+[tool.ruff.lint.per-file-ignores]
+"**/tests/**/*.py" = [
+    "S101",
+]
+
+[tool.ruff.lint.pydocstyle]
+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 = [
+    "tests",
+]
+
+[tool.bandit]
+exclude_dirs = [
+    ".*",
+]
+
+[tool.bandit.assert_used]
+skips = [
+    "*/tests/*.py",
+]

pyrig-3.0.9/pyrig/dev/__init__.py

@@ -0,0 +1,6 @@
+"""Development-time infrastructure for pyrig projects.
+
+This package contains development tools, configuration management, CLI,
+artifact building, and testing infrastructure. These components are used
+during development and CI/CD but are not required at runtime.
+"""

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

@@ -0,0 +1,5 @@
+"""Base classes for artifact builders.
+
+This package provides the abstract Builder base class that all
+artifact builders must inherit from.
+"""