Cookiecutter: Better Project Templates

Cookiecutter creates projects from project templates, e.g. Python package projects.

Basics

• Cookiecutter
  • Features
  • Available Cookiecutters
  • A Pantry Full of Cookiecutters
  • Cookiecutter Specials
  • Community
  • Support This Project
  • Code of Conduct
• Overview
  • Input
  • Output
• Installation
  • Prerequisites
  • Install cookiecutter
  • 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
  • Works with Zip files
  • Keeping your cookiecutters organized
• Additional Tutorials
  • Learn How to Use Cookiecutter
  • Create Your Very Own Cookiecutter Project Template
• Getting to Know Cookiecutter
  • Case Study: cookiecutter-pypackage
  • Step 1: Generate a Python Package Project
  • Step 2: Explore What Got Generated
  • Step 3: Observe How It Was Generated
  • Questions?
  • Summary
• Create a Cookiecutter From Scratch
  • Step 1: Name Your Cookiecutter
  • Step 2: Create project_slug Directory
  • Step 3: Create Files
• Advanced Usage
  • Using Pre/Post-Generate Hooks (0.7.0+)
  • User Config (0.7.0+)
  • Calling Cookiecutter Functions From Python
  • Injecting Extra Context
  • Suppressing Command-Line Prompts
  • Templates in Context Values
  • Copy without Render
  • Replay Project Generation
  • Command Line Options
  • Choice Variables (1.1+)
  • Dictionary Variables (1.5+)
  • Template Extensions
  • Organizing cookiecutters in directories (1.7+)
• 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

API Reference

• cookiecutter package
  • Submodules
  • cookiecutter.cli module
  • cookiecutter.config module
  • cookiecutter.environment module
  • cookiecutter.exceptions module
  • cookiecutter.extensions module
  • cookiecutter.find module
  • cookiecutter.generate module
  • cookiecutter.hooks module
  • cookiecutter.log module
  • cookiecutter.main module
  • cookiecutter.prompt module
  • cookiecutter.replay module
  • cookiecutter.repository module
  • cookiecutter.utils module
  • cookiecutter.vcs module
  • cookiecutter.zipfile module
  • Module contents

Project Info

• Contributing
  • Types of Contributions
  • Setting Up the Code for Local Development
  • Contributor Guidelines
  • Testing with tox
  • Core Committer Guide
• Credits
  • Development Leads
  • Core Committers
  • Contributors
• Sprint Contributors
  • PyCon 2016 Sprint
• History
  • 1.8.0 (Current master, in development)
  • 1.7.3 (2021-05-14)
  • 1.7.2 (2020-04-21)
  • 1.7.1 (2019-04-21)
  • 1.7.0 (2019-12-22) Old friend
  • 1.6.0 (2017-10-15) Tim Tam
  • 1.5.1 (2017-02-04) Alfajor
  • 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)
• Case Studies
  • BeeWare
  • ChrisDev
  • OpenStack
• Backers
• Code of Conduct

Index

• Index

• Module Index