Cookiecutter: Better Project Templates

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

Basics

• Cookiecutter
  • Installation
  • Features
  • Available Templates
  • Community
  • Code of Conduct
  • Acknowledgements
• Overview
  • Input
  • Output
• Installation
  • Prerequisites
  • Install cookiecutter
  • Alternate installations
  • Upgrading
• 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
• Command Line Options
  • cookiecutter
• Tutorials
  • Getting to Know Cookiecutter
  • Create a Cookiecutter From Scratch
  • External Links
• Advanced Usage
  • Hooks
  • User Config
  • Calling Cookiecutter Functions From Python
  • Injecting Extra Context
  • Suppressing Command-Line Prompts
  • Templates in Context Values
  • Private Variables
  • Copy without Render
  • Replay Project Generation
  • Choice Variables
  • Boolean Variables
  • Dictionary Variables
  • Templates inheritance (2.2+)
  • Template Extensions
  • Organizing cookiecutters in directories
  • Customizing the Jinja2 environment
  • Working with line-ends special symbols LF/CRLF
  • Local Extensions
  • Nested configuration files
  • Human readable prompts
• 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
  • Backers
  • Sprint Contributors
• History
  • 2.6.0 (2024-02-21)
  • 2.5.0 (2023-11-21)
  • 2.4.0 (2023-09-29)
  • 2.3.1 (2023-09-21)
  • 2.3.0 (2023-08-03)
  • 2.2.3 (2023-07-11)
  • 2.2.2 (2023-07-10)
  • 2.2.0 (2023-07-06)
  • 2.1.1 (2022-06-01)
  • 2.1.0 (2022-05-30)
  • 2.0.2 (2021-12-27)
  • 2.0.1 (2021-12-11)
  • 1.7.2 (2020-04-21)
  • 1.7.1 (2020-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
• Code of Conduct

Index

• Index

• Module Index