Python Package Cookiecutter Template

There are many cookiecutter templates, but this one is mine and I'm sharing it with you. Create complete Python packages with zero configuration - including CLI, testing, documentation, and automated PyPI publishing via GitHub Actions.

Features

• Zero Configuration CI/CD - Complete GitHub Actions workflows for testing, building, and publishing to PyPI
• CLI Ready - Typer CLI with help and autocompletion
• Fast Dependencies - uv for lightning-fast package management
• Quality Tools - Pre-configured ruff, ty, pytest, and coverage reporting
• Documentation - MkDocs with auto-deployment to GitHub Pages
• Flexible - Optional Pydantic settings, multiple build backends, cross-platform testing

Quick Start

Create Your Project

# With uvx (recommended)
uvx cookiecutter gh:JnyJny/python-package-cookiecutter

# Or with pip
pip install cookiecutter
cookiecutter gh:JnyJny/python-package-cookiecutter

Start Developing

cd your-new-project
poe --help          # See all available tasks
poe qc              # Run quality checks
poe test            # Run tests
poe publish_patch   # Release to PyPI

That's it! Your package is now live on PyPI with documentation deployed to GitHub Pages.

Documentation

For detailed information, see the complete documentation:

📚 https://jnyjny.github.io/python-package-cookiecutter/

• Overview - Template features and benefits
• Quick Start - Step-by-step getting started guide
• Template Guide - Detailed feature documentation
• Customization - How to modify your generated project

Contributing

Found a bug or want to contribute? Please see our Contributing Guidelines and feel free to open an issue or pull request.

License

This template is released under the Apache License 2.0. Generated projects use the license you choose during template creation.