Python Package Template
Cookiecutter template for creating Python packages with complete CI/CD setup and automatic PyPI publishing.
Features
- Modern tools: Hatchling, uv, Ruff, MyPy, Pytest
- CI/CD out of the box: GitHub Actions with automatic PyPI publishing
- Release management: Release Please + Conventional Commits
- Code quality: linting, typing, tests, security checks
- Ready commands: Makefile for all development tasks
Quick Start
Using cookiecutter directly
# Install cookiecutter
pip install cookiecutter
# Create project
cookiecutter https://github.com/serafinovsky/cookiecutter-uv-package
# Setup development environment
cd your-project-name
make dev-setup
Using CLI tool
# Install the CLI tool
pip install cookiecutter-uv-package
# Get help with available arguments
cookiecutter-uv-package --help
# Create project with CLI
cookiecutter-uv-package
# Or with custom options
cookiecutter-uv-package --output-dir /path/to/projects --no-input
# Setup development environment
cd your-project-name
make dev-setup
Configuration Options
When creating a project, you'll be asked to configure:
- project_name: Display name for your package (e.g., "My Awesome Package")
- project_short_description: Brief description of what your package does
- author_name: Your name
- author_email: Your email address
- github_username: Your GitHub username
- python_versions: Supported Python versions (default: "3.11, 3.12, 3.13")
- use_docker: Whether to include Docker support (yes/no)
- deployment_setup: Choose deployment setup (none/github-ci/github-ci-pypi)
- license: Choose license (MIT/Apache-2.0/BSD-3-Clause/GPL-3.0/ISC/none)
Main Commands
make dev-setup # Setup development environment
make test # Run tests
make check # Check code
make format # Format code
make build # Build package
What You Get
- Ready Python package with proper structure
- CI/CD pipeline with GitHub Actions
- Automatic PyPI publishing
- Version management via Release Please
Example Project
See a real example of this template in action: demo-example-package
Documentation
- Full Documentation - Complete guide and reference
- Tutorial - Step-by-step setup guide
- Features - Detailed feature descriptions
- Examples - Usage examples and scenarios
License
MIT License
Metadata
Release files for cookiecutter-uv-package 1.0.15
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| cookiecutter_uv_package-1.0.15.tar.gz | 118.6 kB | Without provenance | Details for cookiecutter_uv_package-1.0.15.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| cookiecutter_uv_package-1.0.15-py3-none-any.whl | Python 3 | none | any | Details for cookiecutter_uv_package-1.0.15-py3-none-any.whl |
Total release size: 158.8 kB
Security for cookiecutter-uv-package 1.0.15
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.