cookiecutter
Cookiecutter
Features
Available Cookiecutters
Cookiecutter Specials
Categories of Cookiecutters
Community
Support This Project
Code of Conduct
A Pantry Full of Cookiecutters
Python
Python-Django
Python-Pyramid
Cookiecutter (meta)
C
C++
C#
Common Lisp
Golang
JS
Kotlin
LaTeX/XeTeX
PHP
Berkshelf-Vagrant
HTML
Scala
6502 Assembly
Data Science
Reproducible Science
Similar projects
Overview
Input
Output
Installation
Alternate installations
Upgrading from 0.6.4 to 0.7.0 or greater
Usage
Grab a Cookiecutter template
Make your changes
Generate your project
Works directly with git and hg (mercurial) repos too
Works with private repos
Keeping your cookiecutters organized
Learn the Basics of Cookiecutter by Creating a Cookiecutter
Your First Cookiecutter
Additional Tutorials
Learn How to Use Cookiecutter
Create Your Very Own Cookiecutter Project Template
Advanced Usage
Using Pre/Post-Generate Hooks (0.7.0+)
Example: Validating template variables
User Config (0.7.0+)
Calling Cookiecutter Functions From Python
Injecting Extra Context
Example: Injecting a Timestamp
Suppressing Command-Line Prompts
Basic Example: Using the Defaults
Advanced Example: Defaults + Extra Context
Templates in Context Values
Basic Example: Templates in Context
Copy without Render
Replay Project Generation
Command Line Options
Choice Variables (1.1+)
Basic Usage
Overwriting Default Choice Values
Dictionary Variables (1.5+)
Basic Usage
Template Extensions
Troubleshooting
I created a cookiecutter, but it doesn’t work, and I can’t figure out why
I’m having trouble generating Jinja templates from Jinja templates
Other common issues
cookiecutter package
Submodules
cookiecutter.cli module
cookiecutter.cli
cookiecutter.config module
cookiecutter.config
cookiecutter.environment module
cookiecutter.exceptions module
cookiecutter.exceptions
cookiecutter.find module
cookiecutter.generate module
cookiecutter.hooks module
cookiecutter.main module
cookiecutter.main
cookiecutter.prompt module
cookiecutter.prompt
cookiecutter.replay module
cookiecutter.replay
cookiecutter.repository module
cookiecutter.utils module
cookiecutter.utils
cookiecutter.vcs module
Module contents
cookiecutter
Contributing
1. Types of Contributions
1.1. Create Cookiecutter Templates
1.2. Report Bugs
1.3. Fix Bugs
1.4. Implement Features
1.5. Write Documentation
1.6. Submit Feedback
2. Setting Up the Code for Local Development
3. Contributor Guidelines
3.1. Pull Request Guidelines
3.2. Coding Standards
4. Testing with tox
5. Troubleshooting for Contributors
5.1. Python 3.3 tests fail locally
6. Core Committer Guide
6.1. Vision and Scope
6.1.1. Command-Line Accessible
6.1.2. API Accessible
6.1.3. Being Jinja2-specific
6.1.4. Extensible
6.1.5. Fast and Focused
6.1.6. Inclusive
6.1.7. Stable
6.1.8. VCS-Hosted Templates
6.2. Process: Pull Requests
6.3. Process: Issues
6.4. Process: Roadmap
6.5. Process: Pull Request merging and HISTORY.rst maintenance
6.6. Process: Accepting Template Pull Requests
6.7. Process: Generating CONTRIBUTING.rst
6.8. Process: Your own code changes
6.9. Responsibilities
6.10. Becoming a Core Committer
Credits
Development Leads
Core Committers
Contributors
Sprint Contributors
PyCon 2016 Sprint
History
1.5.0 (2016-12-18) Alfajor
1.4.0 (2016-03-20) Shortbread
1.3.0 (2015-11-10) Pumpkin Spice
1.2.1 (2015-10-18) Zimtsterne
1.1.0 (2015-09-26) Snickerdoodle
1.0.0 (2015-03-13) Chocolate Chip
0.9.0 (2015-01-13)
0.8.0 (2014-10-30)
0.7.2 (2014-08-05)
0.7.1 (2014-04-26)
0.7.0 (2013-11-09)
0.6.4 (2013-08-21)
0.6.3 (2013-08-20)
0.6.2 (2013-08-19)
0.6.1 (2013-08-12)
0.6.0 (2013-08-08)
0.5 (2013-07-28)
0.4 (2013-07-22)
0.3 (2013-07-17)
0.2.1 (2013-07-17)
0.2 (2013-07-17)
0.1.0 (2013-07-11)
Roadmap
cookiecutter
Docs
»
Overview: module code
All modules for which code is available
cookiecutter.cli
cookiecutter.config
cookiecutter.environment
cookiecutter.exceptions
cookiecutter.find
cookiecutter.generate
cookiecutter.hooks
cookiecutter.main
cookiecutter.prompt
cookiecutter.replay
cookiecutter.repository
cookiecutter.utils
cookiecutter.vcs