Skip to main content

Python Package Template

Cookiecutter Tests passed License Tox Pytest Ruff Documentation

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

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)

Source distribution for cookiecutter-uv-package 1.0.15
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)

Table of built distributions (wheels) for cookiecutter-uv-package 1.0.15
File Interpreter ABI Platform Actions
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

Release files / cookiecutter_uv_package-1.0.15.tar.gz

Download URL cookiecutter_uv_package-1.0.15.tar.gz
Size 118.6 kB
Tags Source
SHA-256 checksum
How to use checksums
61cc25da1f938db49087d2a5b12ded5fdb69bc9966bb95b4942b5597e870e6dc
BLAKE2b-256 checksum
How to use checksums
2cdcb693a0a650ed60ea5a265d066b12247051ddb0c420e4fb30faf36bf3f641
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.12

Release files / cookiecutter_uv_package-1.0.15-py3-none-any.whl

Download URL cookiecutter_uv_package-1.0.15-py3-none-any.whl
Size 40.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5c9a464be95e3a806bb54a06dae859dc949ad73f676ae262f290b53a14888d10
BLAKE2b-256 checksum
How to use checksums
b0f7e083bb38be70d2f3d296203d92233248968ebdde26d2cace4cb052eeb3a5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.12

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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page