Cookiecutter PyPackage

Cookiecutter template for a Python package with production-ready CI and automated PyPI publishing.

• GitHub | PyPI | Documentation
• Created by Audrey M. Roy Greenfeld | GitHub @audreyfeldroy | PyPI @audreyr
• MIT License

What you get

Tooling

CI/CD (GitHub Actions, security-hardened)

All actions pinned by SHA, minimal permissions, no persisted credentials.

Quickstart

Install uv, then:

uvx cookiecutter-pypackage

You'll be prompted for your package name, GitHub username, and a few other values (full list). Follow the tutorial to generate, verify, and release your package.

uv venv
source .venv/bin/activate
uv pip install cookiecutter
cookiecutter --keep-project-on-failure gh:audreyfeldroy/cookiecutter-pypackage

Override template variables

Pass key=value arguments to prefill prompts, or add --no-input for automation:

uvx cookiecutter-pypackage full_name="Your Name"

See Template prompts and command-line options for all variables, defaults, and automation options.

Documentation

audreyfeldroy.github.io/cookiecutter-pypackage

• Tutorial - from generation to first PyPI release
• Project Structure - what's in the generated project
• GitHub Actions - CI, publish, docs deployment, security hardening
• Prompts - what each prompt means
• Troubleshooting

Alternatives

This template is opinionated. If it doesn't fit:

• Browse the fork network for variants
• Create your own template from scratch

Pull requests welcome if they're small, atomic, and improve the template.

Cookiecutter PyPackage and Stead

I maintain Cookiecutter PyPackage as part of how I build software. I’m also building Stead, a home for your creative work with less website maintenance to think about.

I used Stead to create a home for our Ambria series. It makes me feel better about relaunching the books, without the mental overhead of maintaining another website.

If Cookiecutter PyPackage has helped you, I’d love it if you helped sustain my open-source work by exploring Stead or sharing it with a creator who wants a home for their work.

See Ambria · Explore Stead

Discord | MIT license