Python Project Template

My personal template for Python projects.

Features

• Modern Python tooling with uv for dependency management and environment setup
• Generated pyproject.toml with project metadata, dependencies, tool config, and build settings
• Just recipes with just for checking, coverage, testing, linting, formatting, and building
• Code quality tooling with ruff, pyrefly, and pre-commit hooks
• Testing setup with pytest, coverage, and uv-powered local cross-version test runs from .python-versions
• Optional GitHub Actions workflows for linting, testing, and PyPI publishing
• Optional GitHub repository setup through GitHub CLI
• License selection using choosealicense.com license text
• Generated README.md with badges and installation instructions
• Optional documentation setup with Read the Docs, Sphinx, Furo, MyST, API docs, and project links

Requirements

• Python 3.12+
• sprout
• Git
• GitHub CLI (optional)

Usage

sprout "https://github.com/zigai/python-project-template.git" /path/to/your/project

Generated Project Structure

your-project/
├── your_package/
│   ├── __init__.py
│   └── py.typed
├── .github/workflows/          # optional selected workflows
├── .python-version             # default local Python version
├── .python-versions            # local test matrix Python versions
├── .pre-commit-config.yaml
├── pyproject.toml             
├── README.md                  
├── CONTRIBUTING.md             
├── docs/                       # optional Read the Docs site
├── .readthedocs.yaml           # optional Read the Docs config
├── Justfile                    
├── LICENSE                     # omitted when no license is selected
└── .gitignore                  

Similar Templates

• cookiecutter-uv
• copier-uv
• python-copier-template

License

MIT