Cookiecutter

A command-line utility that creates projects from project templates, e.g. creating a Python package project from a Python package project template.

Documentation: http://cookiecutter.rtfd.org
GitHub: https://github.com/audreyr/cookiecutter
Free software: BSD license
PyPI: https://pypi.python.org/pypi/cookiecutter

Features

Simple command line usage.
Works with any type of text file.

Directory names and filenames can be templated. For example:

{{project.repo_name}}/{{project.repo_name}}/{{project.repo_name}}.py

Supports unlimited levels of directory nesting.

Simply define your template variables in a JSON file. For example:

{
    "full_name": "Audrey Roy",
    "email": "audreyr@gmail.com",
    "project_name": "A Lot of Effort",
    "repo_name": "alotofeffort",
    "project_short_description": "Deploy static HTML sites to S3 with the simple 'alotofeffort' command.",
    "release_date": "2013-07-10",
    "year": "2013",
    "version": "0.1.1"
}

All templating is done with Jinja2. Cookiecutter simply renders a directory of Jinja2 templates to files, including rendering the dir names and filenames.

Cookiecutter Project Templates

Here is a list of the Cookiecutter project templates that exist as of now:

cookiecutter-pypackage: @audreyr’s ultimate Python package project template. https://github.com/audreyr/cookiecutter-pypackage

Make your own, then submit a pull request adding yours to this list!

Similar projects

Paste has a create option that creates a skeleton project: http://pythonpaste.org/script/#paster-create
Diecutter: an API service that will give you back a configuration file from a template and variables. https://github.com/novagile/diecutter
Django’s startproject and startapp commands can take in a –template option: https://docs.djangoproject.com/en/1.5/ref/django-admin/#django-admin-startproject

History

0.4 (2013-07-22)

Only takes in one argument now: the input directory. The output directory is generated by rendering the name of the input directory.
Output directory cannot be the same as input directory.

0.3 (2013-07-17)

Takes in command line args for the input and output directories.

0.2.1 (2013-07-17)

Minor cleanup.

0.2 (2013-07-17)

Bumped to “Development Status :: 3 - Alpha”.

Works with any type of text file.
Directory names and filenames can be templated.

0.1.0 (2013-07-11)

First release on PyPI.

Development Status
- 3 - Alpha
Environment
- Console
Intended Audience
- Developers
License
- OSI Approved :: BSD License
Natural Language
- English
Programming Language

Metadata

Development Status
- 3 - Alpha
Environment
- Console
Intended Audience
- Developers
License
- OSI Approved :: BSD License
Natural Language
- English
Programming Language

Release files for cookiecutter 0.4

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 0.4
File	Size	Uploaded
cookiecutter-0.4.tar.gz	6.4 kB	Jul 21, 2013	Details

Release files / cookiecutter-0.4.tar.gz

Download URL	cookiecutter-0.4.tar.gz
Size	6.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`fca4f73cbb04eecc3f696482e1e2971785c81957aeb5ae6d8121b0fdefec9e55`
BLAKE2b-256 checksum How to use checksums	`30f28fb8743e6d96177b00598711031a5811893e92ff0e18660f96de2df28690`
Upload date	Jul 21, 2013
Uploaded using Trusted Publishing? What is trusted publishing?	No