Skip to main content
Documentation Status https://github.com/MacHu-GWU/cookiecutter_maker-project/actions/workflows/main.yml/badge.svg https://codecov.io/gh/MacHu-GWU/cookiecutter_maker-project/branch/main/graph/badge.svg https://img.shields.io/pypi/v/cookiecutter-maker.svg https://img.shields.io/pypi/l/cookiecutter-maker.svg https://img.shields.io/pypi/pyversions/cookiecutter-maker.svg https://img.shields.io/badge/✍️_Release_History!--None.svg?style=social&logo=github https://img.shields.io/badge/⭐_Star_me_on_GitHub!--None.svg?style=social&logo=github
https://img.shields.io/badge/Link-Document-blue.svg https://img.shields.io/badge/Link-API-blue.svg https://img.shields.io/badge/Link-Install-blue.svg https://img.shields.io/badge/Link-GitHub-blue.svg https://img.shields.io/badge/Link-Submit_Issue-blue.svg https://img.shields.io/badge/Link-Request_Feature-blue.svg https://img.shields.io/badge/Link-Download-blue.svg

Welcome to cookiecutter_maker Documentation

https://cookiecutter-maker.readthedocs.io/en/latest/_static/cookiecutter_maker-logo.png

What is Cookiecutter Maker?

cookiecutter creates new projects from a template. cookiecutter_maker does the reverse: it turns a working project into a cookiecutter template.

Writing a template by hand means editing a project full of {{ cookiecutter.xxx }} that you can’t run or test. With cookiecutter_maker, you keep developing a normal project (the “seed”), and generate the template from it whenever it changes. You tell it which concrete values to parameterize, it takes care of the rest:

  • Replaces the values in file contents, file names and folder names.

  • Replaces a value only in the context you want, e.g. the project version but not a dependency that happens to have the same version.

  • Limits a parameter to some files, e.g. replace the version in pyproject.toml but not in CHANGELOG.md.

  • Keeps existing Jinja2 syntax (GitHub Actions ${{ }}, HTML templates, {}} in JSON …) working in the generated projects.

  • Filters files with .gitignore style patterns, and copies binary or “do not touch” files as is.

  • Writes cookiecutter.json, with defaults, choices and prompts.

30 Seconds Example

Next to your project acme_tools-project/, create a cookiecutter-maker.json:

{
    "dir_input": "./acme_tools-project",
    "dir_output": "./template",
    "parameters": [
        {"selector": ["acme_tools"], "name": "package_name", "default": "acme_tools"},
        {"selector": ["0.1.0"], "name": "version", "default": "0.1.0"},
        {"selector": ["Alice"], "name": "author", "default": "Alice"}
    ],
    "exclude": [".git", ".venv", "__pycache__"]
}

Generate the template, then use it like any cookiecutter template:

$ uvx --from "cookiecutter-maker[cli]" cookiecutter-maker make
$ uvx cookiecutter ./template

Prefer Python? The same thing is available as cookiecutter_maker.api.Maker. See the Quick Start for the full walkthrough.

Install

cookiecutter_maker is released on PyPI. Install the library and the command line interface:

$ pip install "cookiecutter-maker[cli]"

Or only the library, for the Python API:

$ pip install cookiecutter-maker

Or run the command line without installing, using uv:

$ uvx --from "cookiecutter-maker[cli]" cookiecutter-maker --help

Use With AI Coding Agents

This repo ships an Agent Skill that teaches AI coding agents such as Claude Code how to use cookiecutter_maker: the public API, the command line options and the config file format, without reading the source code.

Copy the pypi-cookiecutter_maker folder into your project’s .claude/skills/ (or ~/.claude/skills/ for all projects). The agent then loads it automatically whenever you ask it to turn a project into a cookiecutter template.

Metadata

Release files for cookiecutter_maker 1.1.0

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_maker 1.1.0
File Size Uploaded Provenance Actions
cookiecutter_maker-1.1.0.tar.gz 33.6 kB Without provenance Details for cookiecutter_maker-1.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for cookiecutter_maker 1.1.0
File Interpreter ABI Platform Actions
cookiecutter_maker-1.1.0-py3-none-any.whl Python 3 none any Details for cookiecutter_maker-1.1.0-py3-none-any.whl

Total release size: 60.8 kB

Release files / cookiecutter_maker-1.1.0.tar.gz

Download URL cookiecutter_maker-1.1.0.tar.gz
Size 33.6 kB
Tags Source
SHA-256 checksum
How to use checksums
da38f26ef69800319e3482d0cc4084264d63c7a4160dd9cc8f9e3eccdc8d1929
BLAKE2b-256 checksum
How to use checksums
20c4f9abf2d48084d091648934bd244357658fd984db73f866cac4c8148fea77
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / cookiecutter_maker-1.1.0-py3-none-any.whl

Download URL cookiecutter_maker-1.1.0-py3-none-any.whl
Size 27.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8fecd70effaa75cae9dc542e05adc9e409d2d1e03fb251b054f0fd74f6b8548c
BLAKE2b-256 checksum
How to use checksums
19d22b0f1bb5e818a062a74344307bd6d0099179addee4a7707617f33b7b818b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Security for cookiecutter_maker 1.1.0

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