Skip to content

Scaffolded Project Structure

This page documents the complete file tree that pyrig init produces when run inside a fresh project directory. The example below uses a project named my-project.

Quick Start Recap

uv init my-project --python 3.12
cd my-project
uv add pyrig --dev
uv run pyrig init

Generated File Tree

my-project/
├── .github/
│   ├── ISSUE_TEMPLATE/
│   │   ├── bug_report.yml                  # Bug report issue form
│   │   ├── config.yml                      # Issue template chooser configuration
│   │   └── feature_request.yml             # Feature request issue form
│   ├── workflows/
│   │   ├── health-check.yml                # CI: tests, linting, hooks, dependency audit
│   │   ├── release.yml                     # CD: tagging, GitHub release
│   │   ├── deploy.yml                      # CD: repository and documentation calls
│   │   ├── repository.yml                  # Reusable repository settings/rulesets workflow
│   │   └── documentation.yml               # Reusable documentation build and deployment
│   ├── CODEOWNERS                          # Wildcard code ownership rule for the repo owner
│   ├── configure.sh                        # Repository configuration script
│   ├── pull_request_template.md            # Pull request description template
│   └── settings.json                       # Repository settings and rulesets
├── docs/
│   └── index.md                            # Documentation home page
├── src/
│   └── my_project/                         # Package root (project name → snake_case)
│       ├── __init__.py                     # Top-level package module
│       └── py.typed                        # PEP 561 marker (typed package)
│
├── .gitattributes                          # Git attributes configuration
├── .gitignore                              # Git ignore rules
├── .python-version                         # Python version pin
├── .scratch.py                             # Local scratch file (not committed)
├── CODE_OF_CONDUCT.md                      # Contributor Covenant code of conduct
├── CONTRIBUTING.md                         # Contribution guidelines
├── LICENSE                                 # MIT license
├── prek.toml                               # Version control hook definitions
├── pyproject.toml                          # Package metadata and tool configuration
├── README.md                               # Project README with badges
├── SECURITY.md                             # Security policy
├── uv.lock                                 # Locked dependency manifest
├── vulture_whitelist.py                    # Dead code checker whitelist
└── zensical.toml                           # Documentation site configuration

Notes

  • pyrig init starts from a clean slate. Any managed config file that already exists — e.g. the placeholders uv init creates — is deleted before the tree above is regenerated. pyproject.toml is the only exception; it is never deleted.
  • .scratch.py is version-control-ignored and created locally. It is not committed and can be recreated at any time with pyrig sync. You can run the file to experiment with code snippets with the pyrig scratch command.
  • .github/settings.json and .github/configure.sh are used by the repository workflow, called by deploy, to apply repository settings and protection rulesets via the GitHub API on each release.
  • tests/ is not created by pyrig init. Test files are generated by pyrig sync as you add source modules — each source module gets a mirrored test file skeleton automatically.