Cookiecutter
Create projects swiftly from cookiecutters (project templates) with this command-line utility. Ideal for generating Python package projects and more.
Installation
Install Cookiecutter as a CLI tool with uv:
uv tool install cookiecutter
Features
- Cross-Platform: Supports Windows, Mac, and Linux.
- User-Friendly: No Python knowledge required.
- Versatile: Compatible with Python 3.10 to 3.14.
- Multi-Language Support: Use templates in any language or markup format.
For Users
Quickstart
The most common way to use Cookiecutter is as a command line utility with a GitHub-hosted Cookiecutter template such as https://github.com/audreyfeldroy/cookiecutter-pypackage
Use a GitHub-hosted Cookiecutter template
# You'll be prompted to enter values.
# Then it'll create your Python package in the current working directory,
# based on those values.
# For the sake of brevity, repos on GitHub can just use the 'gh' prefix
$ uvx cookiecutter gh:audreyfeldroy/cookiecutter-pypackage
Use a local template
$ uvx cookiecutter cookiecutter-pypackage/
Use it from Python
If you plan to use Cookiecutter programmatically, please run uv add cookiecutter to add it to your project. Then you can import and use it like this:
from cookiecutter.main import cookiecutter
# Create project from the cookiecutter-pypackage/ template
cookiecutter('cookiecutter-pypackage/')
# Create project from the cookiecutter-pypackage.git repo template
cookiecutter('gh:audreyfeldroy/cookiecutter-pypackage')
If Cookiecutter saves you time, star it on GitHub so other developers can find it too.
Detailed Usage
- Generate projects from local or remote templates.
- Customize projects with
cookiecutter.jsonprompts. - Utilize pre-prompt, pre- and post-generate hooks.
For Template Creators
- Any language, any framework. A Cookiecutter template is just a directory with variables. It works for Python, Rust, Terraform, docs sites, whatever you build repeatedly.
- Hooks for the rest of the setup. Pre- and post-generate scripts (shell or Python) handle git init, dependency installs, or anything else your boilerplate needs.
- One file defines the interface.
cookiecutter.jsondeclares every variable and its default. Users answer prompts; the template does the rest.
Available Templates
Discover a variety of ready-to-use templates on GitHub.
Special Templates
Community
Join the community, contribute, or seek assistance.
Feedback
We value your feedback. Share your criticisms or complaints constructively to help us improve.
Waiting for a Response?
- Be patient and consider reaching out to the community for assistance.
- For enterprise support, contact support@feldroy.com.
Code of Conduct
Adhere to the PyPA Code of Conduct during all interactions in the project's ecosystem.
Acknowledgements
Created and led by Audrey M. Roy Greenfeld, supported by a dedicated team of maintainers and contributors.
Release files for cookiecutter 2.7.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| cookiecutter-2.7.0.tar.gz | 142.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cookiecutter-2.7.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 184.5 kB
Release files / cookiecutter-2.7.0.tar.gz
| Download URL | cookiecutter-2.7.0.tar.gz |
|---|---|
| Size | 142.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b0bf50141201ebf022c95e3fa02a760b64e600b3675d6dabf97563425a62a707
|
|
BLAKE2b-256 checksum How to use checksums |
12f6c576423931c725c30f3c97e1eb5bdb53419c27ff7538751cfa6ad1a07f82
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 2, 2026.
Transparency logRelease files / cookiecutter-2.7.0-py3-none-any.whl
| Download URL | cookiecutter-2.7.0-py3-none-any.whl |
|---|---|
| Size | 41.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
08dc4398e2d8a57771c20703fa10f8d03952e870eddd46bbb832161dc784fa3d
|
|
BLAKE2b-256 checksum How to use checksums |
941f21c082112609cb53d89f86e34ea4fa160c0a5e63556ffa9495ad70566cf1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 2, 2026.
Transparency log
