pax_global_header 0000666 0000000 0000000 00000000064 14565433335 0014525 g ustar 00root root 0000000 0000000 52 comment=da0df9d3a09205749307c403f06a1b4ca3af4cb8
cookiecutter-2.6.0/ 0000775 0000000 0000000 00000000000 14565433335 0014232 5 ustar 00root root 0000000 0000000 cookiecutter-2.6.0/.bandit 0000664 0000000 0000000 00000000057 14565433335 0015476 0 ustar 00root root 0000000 0000000 [bandit]
exclude=tests/*
targets=cookiecutter/
cookiecutter-2.6.0/.gitattributes 0000664 0000000 0000000 00000000257 14565433335 0017131 0 ustar 00root root 0000000 0000000 # By default, all text files should use LF newlines.
* text=auto eol=lf
# Use CRLF newlines for text files containing "crlf" in their names.
*crlf* text=auto eol=crlf
cookiecutter-2.6.0/.github/ 0000775 0000000 0000000 00000000000 14565433335 0015572 5 ustar 00root root 0000000 0000000 cookiecutter-2.6.0/.github/ISSUE_TEMPLATE.md 0000664 0000000 0000000 00000000525 14565433335 0020301 0 ustar 00root root 0000000 0000000 * Cookiecutter version:
* Template project url:
* Python version:
* Operating System:
### Description:
// REPLACE ME: What are you trying to get done, what has happened, what went wrong, and what did you expect?
### What I've run:
```
// REPLACE ME: Paste a log of command(s) you ran and cookiecutter's output, tracebacks, etc, here
```
cookiecutter-2.6.0/.github/dependabot.yml 0000664 0000000 0000000 00000000167 14565433335 0020426 0 ustar 00root root 0000000 0000000 version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "monthly"
cookiecutter-2.6.0/.github/release-drafter.yml 0000664 0000000 0000000 00000002563 14565433335 0021370 0 ustar 00root root 0000000 0000000 commitish: main
name-template: '$RESOLVED_VERSION'
tag-template: '$RESOLVED_VERSION'
category-template: '### $TITLE'
version-resolver:
major:
labels:
- 'breaking-change'
- 'major'
minor:
labels:
- 'enhancement'
- 'feature'
patch:
labels:
- 'bug'
- 'CI/CD'
- 'code style'
- 'documentation'
- 'tests'
- 'patch'
default: patch
autolabeler:
- label: 'CI/CD'
files:
- '.github/*'
- '.pre-commit-config.yaml'
- '*.cfg'
- '*.ini'
- 'setup.*'
- 'docs/conf.py'
- 'Makefile'
- 'make.bat'
- '*requirements*.txt'
- label: 'documentation'
files:
- '*.md'
- '*.rst'
categories:
- title: 'Breaking Changes'
labels:
- 'breaking-change'
- title: 'Non-Breaking Changes'
labels:
- 'major'
- title: 'Minor Changes'
labels:
- 'feature'
- 'enhancement'
- title: 'CI/CD and QA changes'
labels:
- 'CI/CD'
- 'tests'
- 'code style'
- title: 'Documentation updates'
labels:
- 'documentation'
- title: 'Bugfixes'
labels:
- 'bug'
- title: 'Deprecations'
labels:
- 'deprecated'
sort-by: title
sort-direction: ascending
exclude-labels:
- 'skip-changelog'
template: |
## Changes
$CHANGES
### This release is made by wonderful contributors:
$CONTRIBUTORS
cookiecutter-2.6.0/.github/workflows/ 0000775 0000000 0000000 00000000000 14565433335 0017627 5 ustar 00root root 0000000 0000000 cookiecutter-2.6.0/.github/workflows/drafter.yml 0000664 0000000 0000000 00000000630 14565433335 0022000 0 ustar 00root root 0000000 0000000 name: Release Drafter
on:
push:
branches:
- master
# autolabeler
pull_request:
types:
- opened
- reopened
- synchronize
jobs:
update_release_draft:
permissions:
contents: write
pull-requests: write
runs-on: ubuntu-latest
steps:
- uses: release-drafter/release-drafter@v5
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
cookiecutter-2.6.0/.github/workflows/pip-publish.yml 0000664 0000000 0000000 00000001451 14565433335 0022607 0 ustar 00root root 0000000 0000000 name: Upload to PyPI
on:
release:
types: [published]
jobs:
upload:
runs-on: ubuntu-latest
environment:
name: pypi.org
url: https://pypi.org/project/cookiecutter/
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.12"
- name: Install pypa/build
run: >-
python -m
pip install
build
--user
- name: Build a binary wheel and a source tarball
run: >-
python -m
build
--sdist
--wheel
--outdir dist/
.
- name: Publish a Python distribution to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
with:
user: __token__
password: ${{ secrets.PYPI_API_TOKEN }}
cookiecutter-2.6.0/.github/workflows/tests.yml 0000664 0000000 0000000 00000003675 14565433335 0021527 0 ustar 00root root 0000000 0000000 name: CI/CD Tests
on:
push:
branches:
- main
tags:
- "*"
pull_request:
branches:
- "*"
jobs:
documentation_build_test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
submodules: 'recursive'
- uses: actions/setup-python@v5
with:
python-version: "3.10"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install tox
- name: Build docs
run: tox -e docs
- uses: actions/upload-artifact@v4
with:
name: DocumentationHTML
path: docs/_build/html/
tests_run:
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os:
- ubuntu-latest
- macos-latest
- windows-latest
python:
- "3.7"
- "3.8"
- "3.9"
- "3.10"
- "3.11"
- "3.12"
steps:
- uses: actions/checkout@v4
- name: Set up Python ${{ matrix.python }}
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install tox
- name: Project internals test build
run: "tox -e py${{ matrix.python }}"
- name: Project security test
run: "tox -e safety"
- name: Send coverage report to codeclimate
continue-on-error: true
uses: paambaati/codeclimate-action@v5.0.0
with:
coverageCommand: echo "Ignore rerun"
coverageLocations: ${{github.workspace}}/coverage.xml:coverage.py
env:
CC_TEST_REPORTER_ID: ${{secrets.CC_TEST_REPORTER_ID}}
- name: Send coverage report to codecov
uses: codecov/codecov-action@v3
with:
env_vars: OS=${{ matrix.os }},PYTHON=${{ matrix.python }}
file: ./coverage.xml
cookiecutter-2.6.0/.gitignore 0000664 0000000 0000000 00000006353 14565433335 0016231 0 ustar 00root root 0000000 0000000 # Adapted from https://github.com/github/gitignore/blob/main/Python.gitignore
tests/tmp/
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class
# C extensions
*.so
# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST
# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/
# Translations
*.mo
*.pot
# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal
# Flask stuff:
instance/
.webassets-cache
# Scrapy stuff:
.scrapy
# Sphinx documentation
docs/_build/
# PyBuilder
.pybuilder/
target/
# Jupyter Notebook
.ipynb_checkpoints
# IPython
profile_default/
ipython_config.py
# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version
# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock
# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock
# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/#use-with-ide
.pdm.toml
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/
# Celery stuff
celerybeat-schedule
celerybeat.pid
# SageMath parsed files
*.sage.py
# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/
# Spyder project settings
.spyderproject
.spyproject
# Rope project settings
.ropeproject
# mkdocs documentation
/site
# mypy
.mypy_cache/
.dmypy.json
dmypy.json
# Pyre type checker
.pyre/
# pytype static type analyzer
.pytype/
# Cython debug symbols
cython_debug/
# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
.idea/
# VSCode settings (e.g. .vscode/settings.json containing personal preferred path to venv)
.vscode/
# macOS auto-generated file
.DS_Store
cookiecutter-2.6.0/.pre-commit-config.yaml 0000664 0000000 0000000 00000004351 14565433335 0020516 0 ustar 00root root 0000000 0000000 ---
repos:
- repo: meta
hooks:
- id: check-hooks-apply
- id: check-useless-excludes
- repo: https://github.com/PyCQA/doc8
rev: v1.1.1
hooks:
- id: doc8
name: doc8
description: This hook runs doc8 for linting docs.
entry: python -m doc8
language: python
files: \.rst$
require_serial: true
- repo: https://github.com/psf/black-pre-commit-mirror
rev: 24.2.0
hooks:
- id: black
language_version: python3
exclude: ^(tests\/hooks-abort-render\/hooks|docs\/HelloCookieCutter1)
- repo: https://github.com/pycqa/isort
rev: 5.13.2
hooks:
- id: isort
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.5.0
hooks:
- id: trailing-whitespace
- id: mixed-line-ending
name: "Enforce LF newlines on most files"
args:
- "--fix=lf"
# Exclude files with "crlf" in their names.
exclude: "crlf"
- id: mixed-line-ending
name: "Enforce CRLF newlines on files named '*crlf*'"
args:
- "--fix=crlf"
files: "crlf"
- id: end-of-file-fixer
- id: fix-byte-order-marker
- id: check-executables-have-shebangs
- id: check-shebang-scripts-are-executable
- id: check-merge-conflict
- id: check-symlinks
- id: check-case-conflict
- id: check-docstring-first
- id: pretty-format-json
args:
- "--autofix"
- "--indent=2"
- "--no-sort-keys"
- "--no-ensure-ascii"
exclude: "invalid-syntax.json|tests/fake-repo-bad-json/cookiecutter.json|tests/fake-repo/cookiecutter.json"
- id: check-toml
- id: check-xml
- id: check-yaml
exclude: "not_rendered.yml|invalid-config.yaml|invalid-config-w-multiple-docs.yaml"
- repo: https://github.com/PyCQA/flake8
rev: 7.0.0
hooks:
- id: flake8
additional_dependencies:
- flake8-absolute-import
- flake8-black
- flake8-docstrings
- repo: https://github.com/PyCQA/bandit
rev: 1.7.7
hooks:
- id: bandit
args: [--ini, .bandit]
- repo: https://github.com/mgedmin/check-manifest
rev: "0.49"
hooks:
- id: check-manifest
cookiecutter-2.6.0/.readthedocs.yaml 0000664 0000000 0000000 00000000554 14565433335 0017465 0 ustar 00root root 0000000 0000000 # .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
version: 2
build:
os: ubuntu-22.04
tools:
python: "3.10"
sphinx:
configuration: docs/conf.py
formats:
- htmlzip
- pdf
- epub
python:
install:
- requirements: docs/requirements.txt
- method: pip
path: .
cookiecutter-2.6.0/AUTHORS.md 0000664 0000000 0000000 00000027024 14565433335 0015706 0 ustar 00root root 0000000 0000000 # Credits
## Development Leads
- Audrey Roy Greenfeld ([@audreyfeldroy](https://github.com/audreyfeldroy))
- Daniel Roy Greenfeld ([@pydanny](https://github.com/pydanny))
- Raphael Pierzina ([@hackebrot](https://github.com/hackebrot))
## Core Committers
- Michael Joseph ([@michaeljoseph](https://github.com/michaeljoseph))
- Paul Moore ([@pfmoore](https://github.com/pfmoore))
- Andrey Shpak ([@insspb](https://github.com/insspb))
- Sorin Sbarnea ([@ssbarnea](https://github.com/ssbarnea))
- Fábio C. Barrionuevo da Luz ([@luzfcb](https://github.com/luzfcb))
- Simone Basso ([@simobasso](https://github.com/simobasso))
- Jens Klein ([@jensens](https://github.com/jensens))
- Érico Andrei ([@ericof](https://github.com/ericof))
## Contributors
- Steven Loria ([@sloria](https://github.com/sloria))
- Goran Peretin ([@gperetin](https://github.com/gperetin))
- Hamish Downer ([@foobacca](https://github.com/foobacca))
- Thomas Orozco ([@krallin](https://github.com/krallin))
- Jindrich Smitka ([@s-m-i-t-a](https://github.com/s-m-i-t-a))
- Benjamin Schwarze ([@benjixx](https://github.com/benjixx))
- Raphi ([@raphigaziano](https://github.com/raphigaziano))
- Thomas Chiroux ([@ThomasChiroux](https://github.com/ThomasChiroux))
- Sergi Almacellas Abellana ([@pokoli](https://github.com/pokoli))
- Alex Gaynor ([@alex](https://github.com/alex))
- Rolo ([@rolo](https://github.com/rolo))
- Pablo ([@oubiga](https://github.com/oubiga))
- Bruno Rocha ([@rochacbruno](https://github.com/rochacbruno))
- Alexander Artemenko ([@svetlyak40wt](https://github.com/svetlyak40wt))
- Mahmoud Abdelkader ([@mahmoudimus](https://github.com/mahmoudimus))
- Leonardo Borges Avelino ([@lborgav](https://github.com/lborgav))
- Chris Trotman ([@solarnz](https://github.com/solarnz))
- Rolf ([@relekang](https://github.com/relekang))
- Noah Kantrowitz ([@coderanger](https://github.com/coderanger))
- Vincent Bernat ([@vincentbernat](https://github.com/vincentbernat))
- Germán Moya ([@pbacterio](https://github.com/pbacterio))
- Ned Batchelder ([@nedbat](https://github.com/nedbat))
- Dave Dash ([@davedash](https://github.com/davedash))
- Johan Charpentier ([@cyberj](https://github.com/cyberj))
- Éric Araujo ([@merwok](https://github.com/merwok))
- saxix ([@saxix](https://github.com/saxix))
- Tzu-ping Chung ([@uranusjr](https://github.com/uranusjr))
- Caleb Hattingh ([@cjrh](https://github.com/cjrh))
- Flavio Curella ([@fcurella](https://github.com/fcurella))
- Adam Venturella ([@aventurella](https://github.com/aventurella))
- Monty Taylor ([@emonty](https://github.com/emonty))
- schacki ([@schacki](https://github.com/schacki))
- Ryan Olson ([@ryanolson](https://github.com/ryanolson))
- Trey Hunner ([@treyhunner](https://github.com/treyhunner))
- Russell Keith-Magee ([@freakboy3742](https://github.com/freakboy3742))
- Mishbah Razzaque ([@mishbahr](https://github.com/mishbahr))
- Robin Andeer ([@robinandeer](https://github.com/robinandeer))
- Rachel Sanders ([@trustrachel](https://github.com/trustrachel))
- Rémy Hubscher ([@Natim](https://github.com/Natim))
- Dino Petron3 ([@dinopetrone](https://github.com/dinopetrone))
- Peter Inglesby ([@inglesp](https://github.com/inglesp))
- Ramiro Batista da Luz ([@ramiroluz](https://github.com/ramiroluz))
- Omer Katz ([@thedrow](https://github.com/thedrow))
- lord63 ([@lord63](https://github.com/lord63))
- Randy Syring ([@rsyring](https://github.com/rsyring))
- Mark Jones ([@mark0978](https://github.com/mark0978))
- Marc Abramowitz ([@msabramo](https://github.com/msabramo))
- Lucian Ursu ([@LucianU](https://github.com/LucianU))
- Osvaldo Santana Neto ([@osantana](https://github.com/osantana))
- Matthias84 ([@Matthias84](https://github.com/Matthias84))
- Simeon Visser ([@svisser](https://github.com/svisser))
- Guruprasad ([@lgp171188](https://github.com/lgp171188))
- Charles-Axel Dein ([@charlax](https://github.com/charlax))
- Diego Garcia ([@drgarcia1986](https://github.com/drgarcia1986))
- maiksensi ([@maiksensi](https://github.com/maiksensi))
- Andrew Conti ([@agconti](https://github.com/agconti))
- Valentin Lab ([@vaab](https://github.com/vaab))
- Ilja Bauer ([@iljabauer](https://github.com/iljabauer))
- Elias Dorneles ([@eliasdorneles](https://github.com/eliasdorneles))
- Matias Saguir ([@mativs](https://github.com/mativs))
- Johannes ([@johtso](https://github.com/johtso))
- macrotim ([@macrotim](https://github.com/macrotim))
- Will McGinnis ([@wdm0006](https://github.com/wdm0006))
- Cédric Krier ([@cedk](https://github.com/cedk))
- Tim Osborn ([@ptim](https://github.com/ptim))
- Aaron Gallagher ([@habnabit](https://github.com/habnabit))
- mozillazg ([@mozillazg](https://github.com/mozillazg))
- Joachim Jablon ([@ewjoachim](https://github.com/ewjoachim))
- Andrew Ittner ([@tephyr](https://github.com/tephyr))
- Diane DeMers Chen ([@purplediane](https://github.com/purplediane))
- zzzirk ([@zzzirk](https://github.com/zzzirk))
- Carol Willing ([@willingc](https://github.com/willingc))
- phoebebauer ([@phoebebauer](https://github.com/phoebebauer))
- Adam Chainz ([@adamchainz](https://github.com/adamchainz))
- Sulé ([@suledev](https://github.com/suledev))
- Evan Palmer ([@palmerev](https://github.com/palmerev))
- Bruce Eckel ([@BruceEckel](https://github.com/BruceEckel))
- Robert Lyon ([@ivanlyon](https://github.com/ivanlyon))
- Terry Bates ([@terryjbates](https://github.com/terryjbates))
- Brett Cannon ([@brettcannon](https://github.com/brettcannon))
- Michael Warkentin ([@mwarkentin](https://github.com/mwarkentin))
- Bartłomiej Kurzeja ([@B3QL](https://github.com/B3QL))
- Thomas O'Donnell ([@andytom](https://github.com/andytom))
- Jeremy Carbaugh ([@jcarbaugh](https://github.com/jcarbaugh))
- Nathan Cheung ([@cheungnj](https://github.com/cheungnj))
- Abdó Roig-Maranges ([@aroig](https://github.com/aroig))
- Steve Piercy ([@stevepiercy](https://github.com/stevepiercy))
- Corey ([@coreysnyder04](https://github.com/coreysnyder04))
- Dmitry Evstratov ([@devstrat](https://github.com/devstrat))
- Eyal Levin ([@eyalev](https://github.com/eyalev))
- mathagician ([@mathagician](https://github.com/mathagician))
- Guillaume Gelin ([@ramnes](https://github.com/ramnes))
- @delirious-lettuce ([@delirious-lettuce](https://github.com/delirious-lettuce))
- Gasper Vozel ([@karantan](https://github.com/karantan))
- Joshua Carp ([@jmcarp](https://github.com/jmcarp))
- @meahow ([@meahow](https://github.com/meahow))
- Andrea Grandi ([@andreagrandi](https://github.com/andreagrandi))
- Issa Jubril ([@jubrilissa](https://github.com/jubrilissa))
- Nytiennzo Madooray ([@Nythiennzo](https://github.com/Nythiennzo))
- Erik Bachorski ([@dornheimer](https://github.com/dornheimer))
- cclauss ([@cclauss](https://github.com/cclauss))
- Andy Craze ([@accraze](https://github.com/accraze))
- Anthony Sottile ([@asottile](https://github.com/asottile))
- Jonathan Sick ([@jonathansick](https://github.com/jonathansick))
- Hugo ([@hugovk](https://github.com/hugovk))
- Min ho Kim ([@minho42](https://github.com/minho42))
- Ryan Ly ([@rly](https://github.com/rly))
- Akintola Rahmat ([@mihrab34](https://github.com/mihrab34))
- Jai Ram Rideout ([@jairideout](https://github.com/jairideout))
- Diego Carrasco Gubernatis ([@dacog](https://github.com/dacog))
- Wagner Negrão ([@wagnernegrao](https://github.com/wagnernegrao))
- Josh Barnes ([@jcb91](https://github.com/jcb91))
- Nikita Sobolev ([@sobolevn](https://github.com/sobolevn))
- Matt Stibbs ([@mattstibbs](https://github.com/mattstibbs))
- MinchinWeb ([@MinchinWeb](https://github.com/MinchinWeb))
- kishan ([@kishan](https://github.com/kishan3))
- tonytheleg ([@tonytheleg](https://github.com/tonytheleg))
- Roman Hartmann ([@RomHartmann](https://github.com/RomHartmann))
- DSEnvel ([@DSEnvel](https://github.com/DSEnvel))
- kishan ([@kishan](https://github.com/kishan3))
- Bruno Alla ([@browniebroke](https://github.com/browniebroke))
- nicain ([@nicain](https://github.com/nicain))
- Carsten Rösnick-Neugebauer ([@croesnick](https://github.com/croesnick))
- igorbasko01 ([@igorbasko01](https://github.com/igorbasko01))
- Dan Booth Dev ([@DanBoothDev](https://github.com/DanBoothDev))
- Pablo Panero ([@ppanero](https://github.com/ppanero))
- Chuan-Heng Hsiao ([@chhsiao1981](https://github.com/chhsiao1981))
- Mohammad Hossein Sekhavat ([@mhsekhavat](https://github.com/mhsekhavat))
- Amey Joshi ([@amey589](https://github.com/amey589))
- Paul Harrison ([@smoothml](https://github.com/smoothml))
- Fabio Todaro ([@SharpEdgeMarshall](https://github.com/SharpEdgeMarshall))
- Nicholas Bollweg ([@bollwyvl](https://github.com/bollwyvl))
- Jace Browning ([@jacebrowning](https://github.com/jacebrowning))
- Ionel Cristian Mărieș ([@ionelmc](https://github.com/ionelmc))
- Kishan Mehta ([@kishan3](https://github.com/kishan3))
- Wieland Hoffmann ([@mineo](https://github.com/mineo))
- Antony Lee ([@anntzer](https://github.com/anntzer))
- Aurélien Gâteau ([@agateau](https://github.com/agateau))
- Axel H. ([@noirbizarre](https://github.com/noirbizarre))
- Chris ([@chrisbrake](https://github.com/chrisbrake))
- Chris Streeter ([@streeter](https://github.com/streeter))
- Gábor Lipták ([@gliptak](https://github.com/gliptak))
- Javier Sánchez Portero ([@javiersanp](https://github.com/javiersanp))
- Nimrod Milo ([@milonimrod](https://github.com/milonimrod))
- Philipp Kats ([@Casyfill](https://github.com/Casyfill))
- Reinout van Rees ([@reinout](https://github.com/reinout))
- Rémy Greinhofer ([@rgreinho](https://github.com/rgreinho))
- Sebastian ([@sebix](https://github.com/sebix))
- Stuart Mumford ([@Cadair](https://github.com/Cadair))
- Tom Forbes ([@orf](https://github.com/orf))
- Xie Yanbo ([@xyb](https://github.com/xyb))
- Maxim Ivanov ([@ivanovmg](https://github.com/ivanovmg))
## Backers
We would like to thank the following people for supporting us in our efforts to maintain and improve Cookiecutter:
- Alex DeBrie
- Alexandre Y. Harano
- Bruno Alla
- Carol Willing
- Russell Keith-Magee
## Sprint Contributors
### PyCon 2016 Sprint
The following people made contributions to the cookiecutter project at the PyCon sprints in Portland, OR from June 2-5 2016.
Contributions include user testing, debugging, improving documentation, reviewing issues, writing tutorials, creating and updating project templates, and teaching each other.
- Adam Chainz ([@adamchainz](https://github.com/adamchainz))
- Andrew Ittner ([@tephyr](https://github.com/tephyr))
- Audrey Roy Greenfeld ([@audreyfeldroy](https://github.com/audreyfeldroy))
- Carol Willing ([@willingc](https://github.com/willingc))
- Christopher Clarke ([@chrisdev](https://github.com/chrisdev))
- Citlalli Murillo ([@citmusa](https://github.com/citmusa))
- Daniel Roy Greenfeld ([@pydanny](https://github.com/pydanny))
- Diane DeMers Chen ([@purplediane](https://github.com/purplediane))
- Elaine Wong ([@elainewong](https://github.com/elainewong))
- Elias Dorneles ([@eliasdorneles](https://github.com/eliasdorneles))
- Emily Cain ([@emcain](https://github.com/emcain))
- John Roa ([@jhonjairoroa87](https://github.com/jhonjairoroa87))
- Jonan Scheffler ([@1337807](https://github.com/1337807))
- Phoebe Bauer ([@phoebebauer](https://github.com/phoebebauer))
- Kartik Sundararajan ([@skarbot](https://github.com/skarbot))
- Katia Lira ([@katialira](https://github.com/katialira))
- Leonardo Jimenez ([@xpostudio4](https://github.com/xpostudio4))
- Lindsay Slazakowski ([@lslaz1](https://github.com/lslaz1))
- Meghan Heintz ([@dot2dotseurat](https://github.com/dot2dotseurat))
- Raphael Pierzina ([@hackebrot](https://github.com/hackebrot))
- Umair Ashraf ([@umrashrf](https://github.com/umrashrf))
- Valdir Stumm Junior ([@stummjr](https://github.com/stummjr))
- Vivian Guillen ([@viviangb](https://github.com/viviangb))
- Zaro ([@zaro0508](https://github.com/zaro0508))
cookiecutter-2.6.0/CODE_OF_CONDUCT.md 0000664 0000000 0000000 00000000506 14565433335 0017032 0 ustar 00root root 0000000 0000000 # Code of Conduct
Everyone interacting in the Cookiecutter project's codebases and documentation is expected to follow the [PyPA Code of Conduct](https://www.pypa.io/en/latest/code-of-conduct/).
This includes, but is not limited to, issue trackers, chat rooms, mailing lists, and other virtual or in real life communication.
cookiecutter-2.6.0/CONTRIBUTING.md 0000664 0000000 0000000 00000030572 14565433335 0016472 0 ustar 00root root 0000000 0000000 # Contributing
Contributions are welcome, and they are greatly appreciated!
Every little bit helps, and credit will always be given.
- [Types of Contributions](#types-of-contributions)
- [Contributor Setup](#setting-up-the-code-for-local-development)
- [Contributor Guidelines](#contributor-guidelines)
- [Contributor Testing](#testing-with-tox)
- [Core Committer Guide](#core-committer-guide)
## Types of Contributions
You can contribute in many ways:
### Report Bugs
Report bugs at [https://github.com/cookiecutter/cookiecutter/issues](https://github.com/cookiecutter/cookiecutter/issues).
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- If you can, provide detailed steps to reproduce the bug.
- If you don't have steps to reproduce the bug, just note your observations in as much detail as you can.
Questions to start a discussion about the issue are welcome.
### Fix Bugs
Look through the GitHub issues for bugs.
Anything tagged with "bug" is open to whoever wants to implement it.
### Implement Features
Look through the GitHub issues for features.
Anything tagged with "enhancement" and "please-help" is open to whoever wants to implement it.
Please do not combine multiple feature enhancements into a single pull request.
Note: this project is very conservative, so new features that aren't tagged with "please-help" might not get into core.
We're trying to keep the code base small, extensible, and streamlined.
Whenever possible, it's best to try and implement feature ideas as separate projects outside of the core codebase.
### Write Documentation
Cookiecutter could always use more documentation, whether as part of the official Cookiecutter docs, in docstrings, or even on the web in blog posts, articles, and such.
If you want to review your changes on the documentation locally, you can do:
```bash
pip install -r docs/requirements.txt
make servedocs
```
This will compile the documentation, open it in your browser and start watching the files for changes, recompiling as you save.
### Submit Feedback
The best way to send feedback is to file an issue at [https://github.com/cookiecutter/cookiecutter/issues](https://github.com/cookiecutter/cookiecutter/issues).
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
## Setting Up the Code for Local Development
Here's how to set up `cookiecutter` for local development.
1. Fork the `cookiecutter` repo on GitHub.
2. Clone your fork locally:
```bash
git clone git@github.com:your_name_here/cookiecutter.git
```
3. Install your local copy into a virtualenv.
Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
```bash
cd cookiecutter/
pip install -e .
```
4. Create a branch for local development:
```bash
git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
5. When you're done making changes, check that your changes pass the tests and lint check:
```bash
pip install tox
tox
```
6. Ensure that your feature or commit is fully covered by tests. Check report after regular `tox` run.
You can also run coverage only report and get html report with statement by statement highlighting:
```bash
make coverage
```
You report will be placed to `htmlcov` directory. Please do not include this directory to your commits.
By default this directory in our `.gitignore` file.
7. Commit your changes and push your branch to GitHub:
```bash
git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature
```
8. Submit a pull request through the GitHub website.
## Contributor Guidelines
### Pull Request Guidelines
Before you submit a pull request, check that it meets these guidelines:
1. The pull request should include tests.
2. The pull request should be contained:
if it's too big consider splitting it into smaller pull requests.
3. If the pull request adds functionality, the docs should be updated.
Put your new functionality into a function with a docstring, and add the feature to the list in README.md.
4. The pull request must pass all CI/CD jobs before being ready for review.
5. If one CI/CD job is failing for unrelated reasons you may want to create another PR to fix that first.
### Coding Standards
- PEP8
- Functions over classes except in tests
- Quotes via [http://stackoverflow.com/a/56190/5549](http://stackoverflow.com/a/56190/5549)
- Use double quotes around strings that are used for interpolation or that are natural language messages
- Use single quotes for small symbol-like strings (but break the rules if the strings contain quotes)
- Use triple double quotes for docstrings and raw string literals for regular expressions even if they aren't needed.
- Example:
```python
LIGHT_MESSAGES = {
'English': "There are %(number_of_lights)s lights.",
'Pirate': "Arr! Thar be %(number_of_lights)s lights."
}
def lights_message(language, number_of_lights):
"""Return a language-appropriate string reporting the light count."""
return LIGHT_MESSAGES[language] % locals()
def is_pirate(message):
"""Return True if the given message sounds piratical."""
return re.search(r"(?i)(arr|avast|yohoho)!", message) is not None
```
## Testing with tox
`tox` uses `pytest` under the hood, hence it supports the same syntax for selecting tests.
For further information please consult the [pytest usage docs](http://pytest.org/en/latest/example/index.html).
To run a particular test class with `tox`:
```bash
tox -e py310 -- '-k TestFindHooks'
```
To run some tests with names matching a string expression:
```bash
tox -e py310 -- '-k generate'
```
Will run all tests matching "generate", test_generate_files for example.
To run just one method:
```bash
tox -e py310 -- '-k "TestFindHooks and test_find_hook"'
```
To run all tests using various versions of Python, just run `tox`:
```bash
tox
```
This configuration file setup the pytest-cov plugin and it is an additional dependency.
It generate a coverage report after the tests.
It is possible to test with specific versions of Python. To do this, the command is:
```bash
tox -e py37,py38
```
This will run `py.test` with the `python3.7` and `python3.8` interpreters.
## Core Committer Guide
### Vision and Scope
Core committers, use this section to:
- Guide your instinct and decisions as a core committer
- Limit the codebase from growing infinitely
#### Command-Line Accessible
- Provides a command-line utility that creates projects from cookiecutters
- Extremely easy to use without having to think too hard
- Flexible for more complex use via optional arguments
#### API Accessible
- Entirely function-based and stateless (Class-free by intentional design)
- Usable in pieces for developers of template generation tools
#### Being Jinja2-specific
- Sets a standard baseline for project template creators, facilitating reuse
- Minimizes the learning curve for those who already use Flask or Django
- Minimizes scope of Cookiecutter codebase
#### Extensible
Being extendable by people with different ideas for Jinja2-based project template tools.
- Entirely function-based
- Aim for statelessness
- Lets anyone write more opinionated tools
Freedom for Cookiecutter users to build and extend.
- No officially-maintained cookiecutter templates, only ones by individuals
- Commercial project-friendly licensing, allowing for private cookiecutters and private Cookiecutter-based tools
#### Fast and Focused
Cookiecutter is designed to do one thing, and do that one thing very well.
- Cover the use cases that the core committers need, and as little as possible beyond that :)
- Generates project templates from the command-line or API, nothing more
- Minimize internal line of code (LOC) count
- Ultra-fast project generation for high performance downstream tools
#### Inclusive
- Cross-platform and cross-version support are more important than features/functionality
- Fixing Windows bugs even if it's a pain, to allow for use by more beginner coders
#### Stable
- Aim for 100% test coverage and covering corner cases
- No pull requests will be accepted that drop test coverage on any platform, including Windows
- Conservative decisions patterned after CPython's conservative decisions with stability in mind
- Stable APIs that tool builders can rely on
- New features require a +1 from 3 core committers
#### VCS-Hosted Templates
Cookiecutter project templates are intentionally hosted VCS repos as-is.
- They are easily forkable
- It's easy for users to browse forks and files
- They are searchable via standard Github/Bitbucket/other search interface
- Minimizes the need for packaging-related cruft files
- Easy to create a public project template and host it for free
- Easy to collaborate
### Process: Pull Requests
If a pull request is untriaged:
- Look at the roadmap
- Set it for the milestone where it makes the most sense
- Add it to the roadmap
How to prioritize pull requests, from most to least important:
- Fixes for broken tests. Broken means broken on any supported platform or Python version.
- Extra tests to cover corner cases.
- Minor edits to docs.
- Bug fixes.
- Major edits to docs.
- Features.
#### Pull Requests Review Guidelines
- Think carefully about the long-term implications of the change.
How will it affect existing projects that are dependent on this?
If this is complicated, do we really want to maintain it forever?
- Take the time to get things right, PRs almost always require additional improvements to meet the bar for quality.
**Be very strict about quality.**
- When you merge a pull request take care of closing/updating every related issue explaining how they were affected by those changes.
Also, remember to add the author to `AUTHORS.md`.
### Process: Issues
If an issue is a bug that needs an urgent fix, mark it for the next patch release.
Then either fix it or mark as please-help.
For other issues: encourage friendly discussion, moderate debate, offer your thoughts.
New features require a +1 from 2 other core committers (besides yourself).
### Process: Roadmap
The roadmap located [here](https://github.com/cookiecutter/cookiecutter/milestones?direction=desc&sort=due_date&state=open)
Due dates are flexible. Core committers can change them as needed. Note that GitHub sort on them is buggy.
How to number milestones:
- Follow semantic versioning. Look at: [http://semver.org](http://semver.org)
Milestone size:
- If a milestone contains too much, move some to the next milestone.
- Err on the side of more frequent patch releases.
### Process: Your own code changes
All code changes, regardless of who does them, need to be reviewed and merged by someone else.
This rule applies to all the core committers.
Exceptions:
- Minor corrections and fixes to pull requests submitted by others.
- While making a formal release, the release manager can make necessary, appropriate changes.
- Small documentation changes that reinforce existing subject matter.
Most commonly being, but not limited to spelling and grammar corrections.
### Responsibilities
- Ensure cross-platform compatibility for every change that's accepted. Windows, macOS and Linux.
- Create issues for any major changes and enhancements that you wish to make.
Discuss things transparently and get community feedback.
- Don't add any classes to the codebase unless absolutely needed.
Err on the side of using functions.
- Keep feature versions as small as possible, preferably one new feature per version.
- Be welcoming to newcomers and encourage diverse new contributors from all backgrounds.
Look at [Code of Conduct](CODE_OF_CONDUCT.md).
### Becoming a Core Committer
Contributors may be given core commit privileges. Preference will be given to those with:
1. Past contributions to Cookiecutter and other open-source projects.
Contributions to Cookiecutter include both code (both accepted and pending) and friendly participation in the issue tracker.
Quantity and quality are considered.
2. A coding style that the other core committers find simple, minimal, and clean.
3. Access to resources for cross-platform development and testing.
4. Time to devote to the project regularly.
cookiecutter-2.6.0/HISTORY.md 0000664 0000000 0000000 00000227425 14565433335 0015731 0 ustar 00root root 0000000 0000000 # History
History is important, but our current roadmap can be found [here](https://github.com/cookiecutter/cookiecutter/projects)
## 2.6.0 (2024-02-21)
### Minor Changes
* Support Python 3.12 (#1989) @ericof
* Modifying Jinja2 start and end variable strings (#1997) @sacha-c
### CI/CD and QA changes
* Add isort as a pre-commit hook (#1988) @kurtmckee
* Bump actions/setup-python from 4 to 5 (#2000) @dependabot
* Bump actions/upload-artifact from 3 to 4 (#1999) @dependabot
* Quick resolution of #2003 (#2004) @jensens
* Support Python 3.12 (#1989) @ericof
* [pre-commit.ci] pre-commit autoupdate (#1996) @pre-commit-ci
* Quick resolution of #2003 (#2004) @jensens
### Documentation updates
* Support Python 3.12 (#1989) @ericof
### Bugfixes
* Fix regression #2009: Adding value to nested dicts broken (#2010) @jensens
* Fixed errors caused by invalid config files. (#1995) @alanverresen
### This release is made by wonderful contributors:
@alanverresen, @dependabot, @dependabot[bot], @ericof, @jensens, @kurtmckee, @pre-commit-ci, @pre-commit-ci[bot] and @sacha-c
## 2.5.0 (2023-11-21)
### Minor Changes
* Default values can be passed as a dict (#1924) @matveyvarg
* Implement new style for nested templates config (#1981) @ericof
### CI/CD and QA changes
* Bump actions/checkout from 3 to 4 (#1953) @dependabot
* [pre-commit.ci] pre-commit autoupdate (#1977) @pre-commit-ci
* [pre-commit.ci] pre-commit autoupdate (#1957) @pre-commit-ci
### Documentation updates
* Add argument run to pipx command in README.md (#1964) @staeff
* Fix tutorial2 generated HTML (#1971) @aantoin
* Update README.md (#1967) @HarshRanaOC
* Update README.md to fix broken link (#1952) @david-abn
* Update README.md to include installation instructions (#1949) @david-abn
* Update cookiecutter-plone-starter link in readme (#1965) @zahidkizmaz
### Bugfixes
* Fix FileExistsError when using a relative template path (#1968) @pkrueger-cariad
* Fix recursive context overwrites (#1961) @padraic-padraic
### This release is made by wonderful contributors:
@HarshRanaOC, @aantoin, @david-abn, @dependabot, @dependabot[bot], @ericof, @matveyvarg, @padraic-padraic, @pkrueger-cariad, @pre-commit-ci, @pre-commit-ci[bot], @staeff and @zahidkizmaz
## 2.4.0 (2023-09-29)
### Minor Changes
* Gracefully handle files with mixed lined endings (#1942) @EricHripko
* Implement a pre_prompt hook that will run before prompts (#1950) @ericof
### Documentation updates
* Implement a pre_prompt hook that will run before prompts (#1950) @ericof
* update main docstrings to include overwrite_if_exists and skip_if_file_exists (#1947) @david-abn
### This release is made by wonderful contributors:
@EricHripko, @david-abn and @ericof
## 2.3.1 (2023-09-21)
### Minor Changes
* add checkout details to the context (fixes #1759) (#1923) @JonZeolla
### CI/CD and QA changes
* Update the black pre-commit hook URL and version (#1934) @kurtmckee
* Use UTF-8 for file reading/writing (#1937) @rmartin16
### Documentation updates
* Add missing "parent dir" symbol in tutorial 2 (#1932) @tvoirand
* Remove colons from exemplary prompt messages (#1912) @paduszyk
* docs: add install instruction for Void Linux (#1917) @tranzystorek-io
### Bugfixes
* Fix nested templates in Git repository (#1922) @BTatlock
* Fix prompt counter. (#1940) @ericof
* Fix variables with null default not being required (#1919) (#1920) @limtis0
### This release is made by wonderful contributors:
@BTatlock, @JonZeolla, @ericof, @kurtmckee, @limtis0, @paduszyk, @rmartin16, @tranzystorek-io and @tvoirand
## 2.3.0 (2023-08-03)
### Minor Changes
* Improve style of prompts using `rich` (#1901) @vemonet
### CI/CD and QA changes
* Bump paambaati/codeclimate-action from 4.0.0 to 5.0.0 (#1908) @dependabot
* [pre-commit.ci] pre-commit autoupdate (#1907) @pre-commit-ci
### Bugfixes
* Fix replay (#1904) @vemonet
* Support multichoice overwrite (#1903) @Meepit
### This release is made by wonderful contributors:
@Meepit, @dependabot, @dependabot[bot], @ericof, @pre-commit-ci, @pre-commit-ci[bot] and @vemonet
## 2.2.3 (2023-07-11)
### Changes
### Minor Changes
* Add support for adding human-readable labels for choices when defining multiple choices questions (#1898) @vemonet
* Prompt with replay file (#1758) @w1ndblow
### CI/CD and QA changes
* Set cookiecutter/VERSION.txt as source of truth for version number (#1896) @ericof
* [pre-commit.ci] pre-commit autoupdate (#1897) @pre-commit-ci
### Bugfixes
* Fix issue where the prompts dict was not passed for yes_no questions (#1895) @vemonet
* Set cookiecutter/VERSION.txt as source of truth for version number (#1896) @ericof
### This release is made by wonderful contributors:
@ericof, @pre-commit-ci, @pre-commit-ci[bot], @vemonet and @w1ndblow
## 2.2.2 (2023-07-10)
### CI/CD and QA changes
* Improve gitignore (#1889) @audreyfeldroy
* Add warning for jinja2_time (#1890) @henryiii
### This release is made by wonderful contributors:
@audreyfeldroy, @ericof and @henryiii
## 2.2.0 (2023-07-06)
### Changes
* Added timeout on request.get() for ensuring that if a recipient serve… (#1772) @openrefactory
* Fixing Carriage Return Line Feed (CRLF) order in docs #1792 (#1793) @Lahiry
* Reduce I/O (#1877) @kurtmckee
* Remove a pre-commit hook special case (#1875) @kurtmckee
* Remove universal bdist_wheel option; use "python -m build" (#1739) @mwtoews
* Remove unused import from post-generate hook script example (#1795) @KAZYPinkSaurus
* Standardize newlines for all platforms (#1870) @kurtmckee
* feat: Add resolved template repository path as _repo_dir to the context (#1771) @tmeckel
### Minor Changes
* Added support for providing human-readable prompts to the different variables (#1881) @vemonet
* Added: Boolean variable support in JSON (#1626) @liortct
* Added: CLI option to keep project files on failure. (#1669) @MaciejPatro
* Added: Support partially overwrite keys in nested dict (#1692) @cksac
* Added: Templates inheritance (#1485) @simobasso
* Code quality: Tests upgrade: Use pathlib for files read/write (#1718) @insspb
* Inline jinja2-time extension code (#1779) @tranzystorek-io
* Support Python 3.11 (#1850) @kurtmckee
* Support nested config files (#1770) @dariocurr
* preserves original options in `_cookiecutter` (#1874) @kjaymiller
### CI/CD and QA changes
* Add a Dependabot config to autoupdate GitHub workflow actions (#1851) @kurtmckee
* Added: Readthedocs build config (#1707) @insspb
* Bump actions/setup-python from 3 to 4 (#1854) @dependabot
* Bump paambaati/codeclimate-action from 3.0.0 to 4.0.0 (#1853) @dependabot
* CI/CD: Tox -> Nox: Added nox configuration (#1706) @insspb
* CI/CD: Tox -> Nox: Github actions definition minimized + Sync nox and github actions (#1714) @insspb
* CI/CD: Tox -> Nox: Makefile update: Removed watchmedo and sed dependency, tox replaced with nox (#1713) @insspb
* CI/CD: Updated .pre-commit-config.yaml to use latest hooks versions (#1712) @insspb
* Code quality: Core files: Added exception reason reraise when exception class changed (PEP 3134) (#1719) @insspb
* Code quality: Tests upgrade: Use pathlib for files read/write (#1718) @insspb
* Code quality: core files: Format replaced with f-strings (#1716) @insspb
* Code quality: find.py refactored and type annotated (#1721) @insspb
* Code quality: tests files: Simplify statements fixes (#1717) @insspb
* Code quality: utils.make_sure_path_exists refactored and type annotated (#1722) @insspb
* Fixed: recommonmark replaced with myst, as recommonmark is deprecated (#1709) @insspb
* Pretty-format JSON files (#1864) @kurtmckee
* Rename `master` to `main` so CI runs correctly on merge (#1852) @kurtmckee
* Standardize EOF newlines (#1876) @kurtmckee
* Update `.gitignore` and cite where it was copied from (#1879) @kurtmckee
* Update base docs, remove tox (#1858) @ericof
* Update pre-commit hook versions (#1849) @kurtmckee
* Updated: Release drafter configuration (#1704) @insspb
* Use tox (#1866) @kurtmckee
* Verify an expected warning is raised (#1869) @kurtmckee
* fixed failing lint ci action by updating repo of flake8 (#1838) @Tamronimus
### Documentation updates
* Add jinja env docs (#1872) @pamelafox
* Documentation extension: Create a Cookiecutter From Scratch tutorial (#1592) @miro-jelaska
* Easy PR! Fix typos and add minor doc updates (#1741) @Alex0Blackwell
* Expand cli documentation relating to the no-input flag (#1543) (#1587) @jeremyswerdlow
* Fix @audreyr to @audreyfeldroy github account rename (#1604) @ri0t
* Fixed broken links to jinja docs (#1691) @insspb
* Fixed minor typos in docs (#1753) @segunb
* Fixed: Python code block in the replay documentation (#1715) @juhannc
* Fixed: recommonmark replaced with myst, as recommonmark is deprecated (#1709) @insspb
* Improve Docs Readability (#1690) @ryanrussell
* Update base docs, remove tox (#1858) @ericof
* Updated: Boolean Variables documentation and docstrings (#1705) @italomaia
* docs: fix simple typo, shat -> that (#1749) @timgates42
* fixing badge display problem (#1798) @Paulokim1
### Bugfixes
* Fixed the override not working with copy only dir #1650 (#1651) @zhongdai
* Fixed: Removed mention of packages versions, to exclude dependabot warnings alerts (#1711) @insspb
* cleanup files if panics during hooks - bugfix (#1760) @liortct
### This release is made by wonderful contributors:
@Alex0Blackwell, @KAZYPinkSaurus, @Lahiry, @MaciejPatro, @Paulokim1, @Tamronimus, @cksac, @cookies-xor-cream, @dariocurr, @dependabot, @dependabot[bot], @ericof, @insspb, @italomaia, @jeremyswerdlow, @juhannc, @kjaymiller, @kurtmckee, @liortct, @miro-jelaska, @mwtoews, @openrefactory, @pamelafox, @ri0t, @ryanrussell, @segunb, @simobasso, @timgates42, @tmeckel, @tranzystorek-io, @vemonet and @zhongdai
## 2.1.1 (2022-06-01)
### Documentation updates
* Fix local extensions documentation (#1686) @alkatar21
### Bugfixes
* Sanitize Mercurial branch information before checkout. (#1689) @ericof
### This release is made by wonderfull contributors:
@alkatar21, @ericof and @jensens
## 2.1.0 (2022-05-30)
### Changes
* Move contributors and backers to credits section (#1599) @doobrie
* test_generate_file_verbose_template_syntax_error fixed (#1671) @MaciejPatro
* Removed changes related to setuptools_scm (#1629) @ozer550
* Feature/local extensions (#1240) @mwesterhof
### CI/CD and QA changes
* Check manifest: pre-commit, fixes, cleaning (#1683) @jensens
* Follow PyPA guide to release package using GitHub Actions. (#1682) @ericof
### Documentation updates
* Fix typo in dict_variables.rst (#1680) @ericof
* Documentation overhaul (#1677) @jensens
* Fixed incorrect link on docs. (#1649) @luzfcb
### Bugfixes
* Restore accidentally deleted support for click 8.x (#1643) @jaklan
### This release was made possible by our wonderful contributors:
@doobrie, @jensens, @ericof, @luzfcb
## 2.0.2 (2021-12-27)
*Remark: This release never made it to official PyPI*
* Fix Python version number in cookiecutter --version and test on Python 3.10 (#1621) @ozer550
* Removed changes related to setuptools_scm (#1629) @audreyfeldroy @ozer550
## 2.0.1 (2021-12-11)
*Remark: This release never made it to official PyPI*
### Breaking Changes
* Release preparation for 2.0.1rc1 (#1608) @audreyfeldroy
* Replace poyo with pyyaml. (#1489) @dHannasch
* Added: Path templates will be rendered when copy_without_render used (#839) @noirbizarre
* Added: End of line detection and configuration. (#1407) @insspb
* Remove support for python2.7 (#1386) @ssbarnea
### Minor Changes
* Adopt setuptools-scm packaging (#1577) @ssbarnea
* Log the error message when git clone fails, not just the return code (#1505) @logworthy
* allow jinja 3.0.0 (#1548) @wouterdb
* Added uuid extension to be able to generate uuids (#1493) @jonaswre
* Alert user if choice is invalid (#1496) @dHannasch
* Replace poyo with pyyaml. (#1489) @dHannasch
* update AUTHOR lead (#1532) @HosamAlmoghraby
* Add Python 3.9 (#1478) @gliptak
* Added: --list-installed cli option, listing already downloaded cookiecutter packages (#1096) @chrisbrake
* Added: Jinja2 Environment extension on files generation stage (#1419) @insspb
* Added: --replay-file cli option, for replay file distributing (#906) @Cadair
* Added: _output_dir to cookiecutter context (#1034) @Casyfill
* Added: CLI option to ignore hooks (#992) @rgreinho
* Changed: Generated projects can use multiple type hooks at same time. (sh + py) (#974) @milonimrod
* Added: Path templates will be rendered when copy_without_render used (#839) @noirbizarre
* Added: End of line detection and configuration. (#1407) @insspb
* Making code python 3 only: Remove python2 u' sign, fix some strings (#1402) @insspb
* py3: remove futures, six and encoding (#1401) @insspb
* Render variables starting with an underscore. (#1339) @smoothml
* Tests refactoring: test_utils write issues fixed #1405 (#1406) @insspb
### CI/CD and QA changes
* enable branch coverage (#1542) @simobasso
* Make release-drafter diff only between master releases (#1568) @SharpEdgeMarshall
* ensure filesystem isolation during tests execution (#1564) @simobasso
* add safety ci step (#1560) @simobasso
* pre-commit: add bandit hook (#1559) @simobasso
* Replace tmpdir in favour of tmp_path (#1545) @SharpEdgeMarshall
* Fix linting in CI (#1546) @SharpEdgeMarshall
* Coverage 100% (#1526) @SharpEdgeMarshall
* Run coverage with matrix (#1521) @SharpEdgeMarshall
* Lint rst files (#1443) @ssbarnea
* Python3: Changed io.open to build-in open (PEP3116) (#1408) @insspb
* Making code python 3 only: Remove python2 u' sign, fix some strings (#1402) @insspb
* py3: remove futures, six and encoding (#1401) @insspb
* Removed: Bumpversion, setup.py arguments. (#1404) @insspb
* Tests refactoring: test_utils write issues fixed #1405 (#1406) @insspb
* Added: Automatic PyPI deploy on tag creation (#1400) @insspb
* Changed: Restored coverage reporter (#1399) @insspb
### Documentation updates
* Fix pull requests checklist reference (#1537) @glumia
* Fix author name (#1544) @HosamAlmoghraby
* Add missing contributors (#1535) @glumia
* Update CONTRIBUTING.md (#1529) @glumia
* Update LICENSE (#1519) @simobasso
* docs: rewrite the conditional files / directories example description. (#1437) @lyz-code
* Fix incorrect years in release history (#1473) @graue70
* Add slugify in the default extensions list (#1470) @oncleben31
* Renamed cookiecutter.package to API (#1442) @grrlic
* Fixed wording detail (#1427) @steltenpower
* Changed: CLI Commands documentation engine (#1418) @insspb
* Added: Example for conditional files / directories in hooks (#1397) @xyb
* Changed: README.md PyPI URLs changed to the modern PyPI last version (#1391) @brettcannon
* Fixed: Comma in README.md (#1390) @Cy-dev-tex
* Fixed: Replaced no longer maintained pipsi by pipx (#1395) @ndclt
### Bugfixes
* Add support for click 8.x (#1569) @cjolowicz
* Force click<8.0.0 (#1562) @SharpEdgeMarshall
* Remove direct dependency on markupsafe (#1549) @ssbarnea
* fixes prompting private rendered dicts (#1504) @juhuebner
* User's JSON parse error causes ugly Python exception #809 (#1468) @noone234
* config: set default on missing default_context key (#1516) @simobasso
* Fixed: Values encoding on Windows (#1414) @agateau
* Fixed: Fail with gitolite repositories (#1144) @javiersanp
* MANIFEST: Fix file name extensions (#1387) @sebix
### Deprecations
* Removed: Bumpversion, setup.py arguments. (#1404) @insspb
* Removed support for Python 3.6 and PyPy (#1608) @audreyfeldroy
### This release was made possible by our wonderful contributors:
@Cadair, @Casyfill, @Cy-dev-tex, @HosamAlmoghraby, @SharpEdgeMarshall, @agateau, @audreyfeldroy, @brettcannon, @chrisbrake, @cjolowicz, @dHannasch, @gliptak, @glumia, @graue70, @grrlic, @insspb, @javiersanp, @jonaswre, @jsoref, @Jthevos, @juhuebner, @logworthy, @lyz-code, @milonimrod, @ndclt, @noirbizarre, @noone234, @oncleben31, @ozer550, @rgreinho, @sebix, @Sahil-101, @simobasso, @smoothml, @ssbarnea, @steltenpower, @wouterdb, @xyb, Christopher Wolfe and Hosam Almoghraby ( RIAG Digital )
## 1.7.2 (2020-04-21)
* Fixed: Jinja2&Six version limits causing build errors with ansible project [@insspb](https://github.com/insspb) (#1385)
## 1.7.1 (2020-04-21)
This release was focused on internal code and CI/CD changes. During this release
all code was verified to match pep8, pep257 and other code-styling guides.
Project CI/CD was significantly changed, Windows platform checks based on Appveyor
engine was replaced by GitHub actions tests. Appveyor was removed. Also our
CI/CD was extended with Mac builds, to verify project builds on Apple devices.
Important Changes:
* Added: Added debug messages for get_user_config [@ssbarnea](https://github.com/ssbarnea) (#1357)
* Multiple templates per one repository feature added. [@RomHartmann](https://github.com/RomHartmann) (#1224, #1063)
* Update replay.py json.dump indent for easy viewing [@nicain](https://github.com/nicain) (#1293)
* 'future' library replaced with 'six' as a more lightweight python porting library [@asottile](https://github.com/asottile) (#941)
* Added extension: Slugify template filter [@ppanero](https://github.com/ppanero) (#1336)
* Added command line option: `--skip-if-file-exists`, allow to skip the existing files when doing `overwrite_if_exists`. [@chhsiao1981](https://github.com/chhsiao1981) (#1076)
* Some packages versions limited to be compatible with python2.7 and python 3.5 [@insspb](https://github.com/insspb) (#1349)
Internal CI/CD and tests changes:
* Coverage comment in future merge requests disabled [@ssbarnea](https://github.com/ssbarnea) (#1279)
* Fixed Python 3.8 travis tests and setup.py message [@insspb](https://github.com/insspb) (#1295, #1297)
* Travis builds extended with Windows setup for all supported python versions [@insspb](https://github.com/insspb) (#1300, #1301)
* Update .travis.yml to be compatible with latest travis cfg specs [@luzfcb](https://github.com/luzfcb) (#1346)
* Added new test to improve tests coverage [@amey589](https://github.com/amey589) (#1023)
* Added missed coverage lines highlight to pytest-coverage report [@insspb](https://github.com/insspb) (#1352)
* pytest-catchlog package removed from test_requirements, as now it is included in pytest [@insspb](https://github.com/insspb) (#1347)
* Fixed `cov-report` tox invocation environment [@insspb](https://github.com/insspb) (#1350)
* Added: Release drafter support and configuration to exclude changelog update work and focus on development [@ssbarnea](https://github.com/ssbarnea) [@insspb](https://github.com/insspb) (#1356, #1362)
* Added: CI/CD steps for Github actions to speedup CI/CD [@insspb](https://github.com/insspb) (#1360)
* Removed: Appveyor CI/CD completely removed [@insspb](https://github.com/insspb) [@ssbarnea](https://github.com/ssbarnea) [@insspb](https://github.com/insspb) (#1363, #1367)
Code style and docs changes:
* Added black formatting verification on lint stage + project files reformatting [@ssbarnea](https://github.com/ssbarnea) [@insspb](https://github.com/insspb) (#1368)
* Added pep257 docstring for tests/* files [@insspb](https://github.com/insspb) (#1369, #1370, #1371, #1372, #1373, #1374, #1375, #1376, #1377, #1378, #1380, #1381)
* Added pep257 docstring for tests/conftests.py [@kishan](https://github.com/kishan3) (#1272, #1263)
* Added pep257 docstring for tests/replay/conftest.py [@kishan](https://github.com/kishan3) (#1270, #1268)
* Added pep257 docstring for docs/__init__.py [@kishan](https://github.com/kishan3) (#1273, #1265)
* Added missing docstring headers to all files [@croesnick](https://github.com/croesnick) (#1269, #1283)
* Gitter links replaced by Slack in README [@browniebroke](https://github.com/browniebroke) (#1282)
* flake8-docstrings tests added to CI/CD [@ssbarnea](https://github.com/ssbarnea) (#1284)
* Activated pydocstyle rule: D401 - First line should be in imperative mood [@ssbarnea](https://github.com/ssbarnea) (#1285)
* Activated pydocstyle rule: D200 - One-line docstring should fit on one line with quotes [@ssbarnea](https://github.com/ssbarnea) (#1288)
* Activated pydocstyle rule: D202 - No blank lines allowed after function docstring [@ssbarnea](https://github.com/ssbarnea) (#1288)
* Activated pydocstyle rule: D205 - 1 blank line required between summary line and description [@ssbarnea](https://github.com/ssbarnea) (#1286, #1287)
* Activated pydocstyle rule: ABS101 [@ssbarnea](https://github.com/ssbarnea) (#1288)
* Replaced click documentation links to point to version 7 [@igorbasko01](https://github.com/igorbasko01) (#1303)
* Updated submodule link to latest version with documentation links fix [@DanBoothDev](https://github.com/DanBoothDev) (#1388)
* Fixed links in main README file. [@insspb](https://github.com/insspb) (#1342)
* Fix indentation of .cookiecutterrc in README.md [@mhsekhavat](https://github.com/mhsekhavat) (#1322)
* Changed format of loggers invocation [@insspb](https://github.com/insspb) (#1307)
## 1.7.0 (2019-12-22) Old friend
Important Changes:
* Drop support for EOL Python 3.4, thanks to [@jamescurtin](https://github.com/jamescurtin) and [@insspb](https://github.com/insspb) (#1024)
* Drop support for EOL Python 3.3, thanks to [@hugovk](https://github.com/hugovk) (#1024)
* Increase the minimum click version to 7.0, thanks to [@rly](https://github.com/rly) and [@luzfcb](https://github.com/luzfcb) (#1168)
Other Changes:
* PEP257 fixing docstrings in exceptions.py. Thanks to [@MinchinWeb](https://github.com/MinchinWeb) (#1237)
* PEP257 fixing docstrings in replay.py. Thanks to [@kishan](https://github.com/kishan3) (#1234)
* PEP257 fixing docstrings in test_unzip.py. Thanks to [@tonytheleg](https://github.com/tonytheleg) and [@insspb](https://github.com/insspb) (#1236, #1262)
* Fixed tests sequence for appveyor, to exclude file not found bug. Thanks to [@insspb](https://github.com/insspb) (#1257)
* Updates REAMDE.md with svg badge for appveyor. Thanks to [@sobolevn](https://github.com/sobolevn) (#1254)
* Add missing {% endif %} to Choice Variables example. Thanks to [@mattstibbs](https://github.com/mattstibbs) (#1249)
* Core documentation converted to Markdown format thanks to [@wagnernegrao](https://github.com/wagnernegrao), [@insspb](https://github.com/insspb) (#1216)
* Tests update: use sys.executable when invoking python in python 3 only environment thanks to [@vincentbernat](https://github.com/vincentbernat) (#1221)
* Prevent `click` API v7.0 from showing choices when already shown, thanks to [@rly](https://github.com/rly) and [@luzfcb](https://github.com/luzfcb) (#1168)
* Test the codebase with python3.8 beta on tox and travis-ci (#1206), thanks to [@mihrab34](https://github.com/mihrab34)
* Add a [CODE\_OF\_CONDUCT.md](https://github.com/audreyfeldroy/cookiecutter/blob/master/CODE_OF_CONDUCT.md) file to the project, thanks to [@andreagrandi](https://github.com/andreagrandi) (#1009)
* Update docstrings in `cookiecutter/main.py`, `cookiecutter/__init__.py`, and `cookiecutter/log.py` to follow the PEP 257 style guide, thanks to [@meahow](https://github.com/meahow) (#998, #999, #1000)
* Update docstrings in `cookiecutter/utils.py` to follow the PEP 257 style guide, thanks to [@dornheimer](https://github.com/dornheimer)(#1026)
* Fix grammar in *Choice Variables* documentation, thanks to [@jubrilissa](https://github.com/jubrilissa) (#1011)
* Update installation docs with links to the Windows Subsystem and GNU utilities, thanks to [@Nythiennzo](https://github.com/Nythiennzo) for the PR and [@BruceEckel](https://github.com/BruceEckel) for the review (#1016)
* Upgrade flake8 to version 3.5.0, thanks to [@cclauss](https://github.com/cclauss) (#1038)
* Update tutorial with explanation for how cookiecutter finds the template file, thanks to [@accraze](https://github.com/accraze)(#1025)
* Update CI config files to use `TOXENV` environment variable, thanks to [@asottile](https://github.com/asottile) (#1019)
* Improve user documentation for writing hooks, thanks to [@jonathansick](https://github.com/jonathansick) (#1057)
* Make sure to preserve the order of items in the generated cookiecutter context, thanks to [@hackebrot](https://github.com/hackebrot) (#1074)
* Fixed DeprecationWarning for a regular expression on python 3.6, thanks to [@reinout](https://github.com/reinout) (#1124)
* Document use of cookiecutter-template topic on GitHub, thanks to [@ssbarnea](https://github.com/ssbarnea) (#1189)
* Update README badge links, thanks to [@luzfcb](https://github.com/luzfcb) (#1207)
* Update prompt.py to match pep257 guidelines, thanks to [@jairideout](https://github.com/jairideout) (#1105)
* Update link to Jinja2 extensions documentation, thanks to [@dacog](https://github.com/dacog) (#1193)
* Require pip 9.0.0 or newer for tox environments, thanks to [@hackebrot](https://github.com/hackebrot) (#1215)
* Use io.open contextmanager when reading hook files, thanks to [@jcb91](https://github.com/jcb91) (#1147)
* Add more cookiecutter templates to the mix:
* [cookiecutter-python-cli](https://github.com/xuanluong/cookiecutter-python-cli) by [@xuanluong](https://github.com/xuanluong) (#1003)
* [cookiecutter-docker-science](https://github.com/docker-science/cookiecutter-docker-science) by [@takahi-i](https://github.com/takahi-i) (#1040)
* [cookiecutter-flask-skeleton](https://github.com/realpython/cookiecutter-flask-skeleton) by [@mjhea0](https://github.com/mjhea0) (#1052)
* [cookiecutter-awesome](https://github.com/Pawamoy/cookiecutter-awesome) by [@Pawamoy](https://github.com/Pawamoy) (#1051)
* [cookiecutter-flask-ask](https://github.com/chrisvoncsefalvay/cookiecutter-flask-ask) by [@machinekoder](https://github.com/machinekoder) (#1056)
* [cookiecutter-data-driven-journalism](https://github.com/jastark/cookiecutter-data-driven-journalism) by [@JAStark](https://github.com/JAStark) (#1020)
* [cookiecutter-tox-plugin](https://github.com/tox-dev/cookiecutter-tox-plugin) by [@obestwalter](https://github.com/obestwalter) (#1103)
* [cookiecutter-django-dokku](https://github.com/mashrikt/cookiecutter-django-dokku) by [@mashrikt](https://github.com/mashrikt) (#1093)
## 1.6.0 (2017-10-15) Tim Tam
New Features:
* Include template path or template URL in cookiecutter context under `_template`, thanks to [@aroig](https://github.com/aroig) (#774)
* Add a URL abbreviation for GitLab template projects, thanks to [@hackebrot](https://github.com/hackebrot) (#963)
* Add option to use templates from Zip files or Zip URLs, thanks to [@freakboy3742](https://github.com/freakboy3742) (#961)
Bug Fixes:
* Fix an issue with missing default template abbreviations for when a user defined custom abbreviations, thanks to [@noirbizarre](https://github.com/noirbizarre) for the issue report and [@hackebrot](https://github.com/hackebrot) for the fix (#966, #967)
* Preserve existing output directory on project generation failure, thanks to [@ionelmc](https://github.com/ionelmc) for the report and
[@michaeljoseph](https://github.com/michaeljoseph) for the fix (#629, #964)
* Fix Python 3.x error handling for `git` operation failures, thanks to [@jmcarp](https://github.com/jmcarp) (#905)
Other Changes:
* Fix broken link to *Copy without Render* docs, thanks to [@coreysnyder04](https://github.com/coreysnyder04) (#912)
* Improve debug log message for when a hook is not found, thanks to [@raphigaziano](https://github.com/raphigaziano/) (#160)
* Fix module summary and `expand_abbreviations()` doc string as per pep257, thanks to [@terryjbates](https://github.com/terryjbates)
(#772)
* Update doc strings in `cookiecutter/cli.py` and `cookiecutter/config.py` according to pep257, thanks to [@terryjbates](https://github.com/terryjbates) (#922, #931)
* Update doc string for `is_copy_only_path()` according to pep257, thanks to [@mathagician](https://github.com/mathagician) and
[@terryjbates](https://github.com/terryjbates) (#935, #949)
* Update doc strings in `cookiecutter/extensions.py` according to pep257, thanks to [@meahow](https://github.com/meahow) (#996)
* Fix miscellaneous issues with building docs, thanks to [@stevepiercy](https://github.com/stevepiercy) (#889)
* Re-implement Makefile and update several make rules, thanks to [@hackebrot](https://github.com/hackebrot) (#930)
* Fix broken link to pytest docs, thanks to [@eyalev](https://github.com/eyalev) for the issue report and [@devstrat](https://github.com/devstrat) for the fix (#939, #940)
* Add `test_requirements.txt` file for easier testing outside of tox, thanks to [@ramnes](https://github.com/ramnes) (#945)
* Improve wording in *copy without render* docs, thanks to [@eyalev](https://github.com/eyalev) (#938)
* Fix a number of typos, thanks to [@delirious-lettuce](https://github.com/delirious-lettuce) (#968)
* Improved *extra context* docs by noting that extra context keys must be present in the template\'s `cookiecutter.json`, thanks to
[@karantan](https://github.com/karantan) for the report and fix (#863, #864)
* Added more cookiecutter templates to the mix:
* [cookiecutter-kata-cpputest](https://github.com/13coders/cookiecutter-kata-cpputest) by [@13coders](https://github.com/13coders) (#901)
* [cookiecutter-kata-gtest](https://github.com/13coders/cookiecutter-kata-gtest) by [@13coders](https://github.com/13coders) (#901)
* [cookiecutter-pyramid-talk-python-starter](https://github.com/mikeckennedy/cookiecutter-pyramid-talk-python-starter) by [@mikeckennedy](https://github.com/mikeckennedy) (#915)
* [cookiecutter-android](https://github.com/alexfu/cookiecutter-android) by [@alexfu](https://github.com/alexfu) (#890)
* [cookiecutter-lux-python](https://github.com/alexkey/cookiecutter-lux-python) by [@alexkey](https://github.com/alexkey) (#895)
* [cookiecutter-git](https://github.com/webevllc/cookiecutter-git) by [@tuxredux](https://github.com/tuxredux) (#921)
* [cookiecutter-ansible-role-ci](https://github.com/ferrarimarco/cookiecutter-ansible-role) by [@ferrarimarco](https://github.com/ferrarimarco) (#903)
* [cookiecutter\_dotfile](https://github.com/bdcaf/cookiecutter_dotfile) by [@bdcaf](https://github.com/bdcaf) (#925)
* [painless-continuous-delivery](https://github.com/painless-software/painless-continuous-delivery) by [@painless-software](https://github.com/painless-software)
(#927)
* [cookiecutter-molecule](https://github.com/retr0h/cookiecutter-molecule) by [@retr0h](https://github.com/retr0h) (#954)
* [sublime-snippet-package-template](https://github.com/agenoria/sublime-snippet-package-template) by [@agenoria](https://github.com/agenoria) (#956)
* [cookiecutter-conda-python](https://github.com/conda/cookiecutter-conda-python) by [@conda](https://github.com/conda) (#969)
* [cookiecutter-flask-minimal](https://github.com/candidtim/cookiecutter-flask-minimal) by [@candidtim](https://github.com/candidtim) (#977)
* [cookiecutter-pypackage-rust-cross-platform-publish](https://github.com/mckaymatt/cookiecutter-pypackage-rust-cross-platform-publish) by [@mckaymatt](https://github.com/mckaymatt) (#957)
* [cookie-cookie](https://github.com/tuxredux/cookie-cookie) by [@tuxredux](https://github.com/tuxredux) (#951)
* [cookiecutter-telegram-bot](https://github.com/Ars2014/cookiecutter-telegram-bot) by [@Ars2014](https://github.com/Ars2014) (#984)
* [python-project-template](https://github.com/Kwpolska/python-project-template) by [@Kwpolska](https://github.com/Kwpolska) (#986)
* [wemake-django-template](https://github.com/wemake-services/wemake-django-template) by [@wemake-services](https://github.com/wemake-services) (#990)
* [cookiecutter-raml](https://github.com/genzj/cookiecutter-raml) by [@genzj](https://github.com/genzj) (#994)
* [cookiecutter-anyblok-project](https://github.com/AnyBlok/cookiecutter-anyblok-project) by [@AnyBlok](https://github.com/AnyBlok) (#988)
* [cookiecutter-devenv](https://bitbucket.org/greenguavalabs/cookiecutter-devenv.git) by [@greenguavalabs](https://bitbucket.org/greenguavalabs) (#991)
## 1.5.1 (2017-02-04) Alfajor
New Features:
* Major update to installation documentation, thanks to [@stevepiercy](https://github.com/stevepiercy) (#880)
Bug Fixes:
* Resolve an issue around default values for dict variables, thanks to [@e-kolpakov](https://github.com/e-kolpakov) for raising the issue and [@hackebrot](https://github.com/hackebrot) for the PR (#882, #884)
Other Changes:
* Contributor documentation reST fixes, thanks to [@stevepiercy](https://github.com/stevepiercy) (#878)
* Added more cookiecutter templates to the mix:
* [widget-cookiecutter](https://github.com/jupyter/widget-cookiecutter) by [@willingc](https://github.com/willingc) (#781)
* [cookiecutter-django-foundation](https://github.com/Parbhat/cookiecutter-django-foundation) by [@Parbhat](https://github.com/Parbhat) (#804)
* [cookiecutter-tornado](https://github.com/hkage/cookiecutter-tornado) by [@hkage](https://github.com/hkage) (#807)
* [cookiecutter-django-ansible](https://github.com/HackSoftware/cookiecutter-django-ansible) by [@Ivaylo-Bachvarov](https://github.com/Ivaylo-Bachvarov)(#816)
* [CICADA](https://github.com/TAMU-CPT/CICADA) by [@elenimijalis](https://github.com/elenimijalis) (#840)
* [cookiecutter-tf-module](https://github.com/DualSpark/cookiecutter-tf-module) by [@VDuda](https://github.com/VDuda) (#843)
* [cookiecutter-pyqt4](https://github.com/aeroaks/cookiecutter-pyqt4) by [@aeroaks](https://github.com/aeroaks) (#847)
* [cookiecutter-golang](https://github.com/lacion/cookiecutter-golang) by [@mjhea0](https://github.com/mjhea0) and [@lacion](https://github.com/lacion) (#872, #873)
* [cookiecutter-elm](https://github.com/m-x-k/cookiecutter-elm.git), [cookiecutter-java](https://github.com/m-x-k/cookiecutter-java.git) and [cookiecutter-spring-boot](https://github.com/m-x-k/cookiecutter-spring-boot.git) by [@m-x-k](https://github.com/m-x-k) (#879)
## 1.5.0 (2016-12-18) Alfajor
The primary goal of this release was to add command-line support for passing extra context, address minor bugs and make a number of
improvements.
New Features:
* Inject extra context with command-line arguments, thanks to [@msabramo](https://github.com/msabramo) and [@michaeljoseph](https://github.com/michaeljoseph) (#666).
* Updated conda installation instructions to work with the new conda-forge distribution of Cookiecutter, thanks to [@pydanny](https://github.com/pydanny) and especially [@bollwyvl](https://github.com/bollwyvl) (#232, #705).
* Refactor code responsible for interaction with version control systems and raise better error messages, thanks to [@michaeljoseph](https://github.com/michaeljoseph) (#778).
* Add support for executing cookiecutter using `python -m cookiecutter` or from a checkout/zip file, thanks to [@brettcannon](https://github.com/brettcannon) (#788).
* New CLI option `--debug-file PATH` to store a log file on disk. By default no log file is written. Entries for `DEBUG` level and higher. Thanks to [@hackebrot](https://github.com/hackebrot)(#792).
* Existing templates in a user\'s `cookiecutters_dir` (default is `~/.cookiecutters/`) can now be referenced by directory name, thanks
to [@michaeljoseph](https://github.com/michaeljoseph) (#825).
* Add support for dict values in `cookiecutter.json`, thanks to [@freakboy3742](https://github.com/freakboy3742) and [@hackebrot](https://github.com/hackebrot) (#815, #858).
* Add a `jsonify` filter to default jinja2 extensions that json.dumps a Python object into a string, thanks to [@aroig](https://github.com/aroig) (#791).
Bug Fixes:
* Fix typo in the error logging text for when a hook did not exit successfully, thanks to [@luzfcb](https://github.com/luzfcb) (#656)
* Fix an issue around **replay** file names when **cookiecutter** is used with a relative path to a template, thanks to [@eliasdorneles](https://github.com/eliasdorneles) for raising the issue and [@hackebrot](https://github.com/hackebrot) for the PR (#752, #753)
* Ignore hook files with tilde-suffixes, thanks to [@hackebrot](https://github.com/hackebrot) (#768)
* Fix a minor issue with the code that generates a name for a template, thanks to [@hackebrot](https://github.com/hackebrot)(#798)
* Handle empty hook file or other OS errors, thanks to [@christianmlong](https://github.com/christianmlong) for raising this bug and [@jcarbaugh](https://github.com/jcarbaugh) and [@hackebrot](https://github.com/hackebrot) for the fix (#632, #729, #862)
* Resolve an issue with custom extensions not being loaded for `pre_gen_project` and `post_gen_project` hooks, thanks to [@cheungnj](https://github.com/cheungnj) (#860)
Other Changes:
* Remove external dependencies from tests, so that tests can be run w/o network connection, thanks to [@hackebrot](https://github.com/hackebrot) (#603)
* Remove execute permissions on Python files, thanks to [@mozillazg](https://github.com/mozillazg) (#650)
* Report code coverage info from AppVeyor build to codecov, thanks to [@ewjoachim](https://github.com/ewjoachim) (#670)
* Documented functions and methods lacking documentation, thanks to [@pydanny](https://github.com/pydanny) (#673)
* Documented `__init__` methods for Environment objects, thanks to [@pydanny](https://github.com/pydanny) (#677)
* Updated whichcraft to 0.4.0, thanks to [@pydanny](https://github.com/pydanny).
* Updated documentation link to Read the Docs, thanks to [@natim](https://github.com/Natim) (#687)
* Moved cookiecutter templates and added category links, thanks to [@willingc](https://github.com/willingc) (#674)
* Added Github Issue Template, thanks to [@luzfcb](https://github.com/luzfcb) (#700)
* Added `ssh` repository examples, thanks to [@pokoli](https://github.com/pokoli/) (#702)
* Fix links to the cookiecutter-data-science template and its documentation, thanks to [@tephyr](https://github.com/tephyr) for the PR and [@willingc](https://github.com/willingc) for the review (#711, #714)
* Update link to docs for Django\'s `--template` command line option, thanks to [@purplediane](https://github.com/purplediane) (#754)
* Create *hook backup files* during the tests as opposed to having them as static files in the repository, thanks to [@hackebrot](https://github.com/hackebrot) (#789)
* Applied PEP 257 docstring conventions to:
* `environment.py`, thanks to [@terryjbates](https://github.com/terryjbates) (#759)
* `find.py`, thanks to [@terryjbates](https://github.com/terryjbates) (#761)
* `generate.py`, thanks to [@terryjbates](https://github.com/terryjbates) (#764)
* `hooks.py`, thanks to [@terryjbates](https://github.com/terryjbates) (#766)
* `repository.py`, thanks to [@terryjbates](https://github.com/terryjbates) (#833)
* `vcs.py`, thanks to [@terryjbates](https://github.com/terryjbates) (#831)
* Fix link to the Tryton cookiecutter, thanks to [@cedk](https://github.com/cedk) and [@nicoe](https://github.com/nicoe) (#697, #698)
* Added PyCon US 2016 sponsorship to README, thanks to [@purplediane](https://github.com/purplediane) (#720)
* Added a sprint contributor doc, thanks to [@phoebebauer](https://github.com/phoebebauer) (#727)
* Converted readthedocs links (.org -\> .io), thanks to [@adamchainz](https://github.com/adamchainz) (#718)
* Added Python 3.6 support, thanks to [@suledev](https://github.com/suledev) (#728)
* Update occurrences of `repo_name` in documentation, thanks to [@palmerev](https://github.com/palmerev) (#734)
* Added case studies document, thanks to [@pydanny](https://github.com/pydanny) (#735)
* Added first steps cookiecutter creation tutorial, thanks to [@BruceEckel](https://github.com/BruceEckel) (#736)
* Reorganised tutorials and setup git submodule to external tutorial, thanks to [@dot2dotseurat](https://github.com/dot2dotseurat) (#740)
* Debian installation instructions, thanks to [@ivanlyon](https://github.com/ivanlyon) (#738)
* Usage documentation typo fix., thanks to [@terryjbates](https://github.com/terryjbates) (#739)
* Updated documentation copyright date, thanks to [@zzzirk](https://github.com/zzzirk) (#747)
* Add a make rule to update git submodules, thanks to [@hackebrot](https://github.com/hackebrot) (#746)
* Split up advanced usage docs, thanks to [@zzzirk](https://github.com/zzzirk) (#749)
* Documentation for the `no_input` option, thanks to [@pokoli](https://github.com/pokoli/) (#701)
* Remove unnecessary shebangs from python files, thanks to [@michaeljoseph](https://github.com/michaeljoseph) (#763)
* Refactor cookiecutter template identification, thanks to [@michaeljoseph](https://github.com/michaeljoseph) (#777)
* Add a `cli_runner` test fixture to simplify CLI tests, thanks to [@hackebrot](https://github.com/hackebrot) (#790)
* Add a check to ensure cookiecutter repositories have JSON context, thanks to [@michaeljoseph](https://github.com/michaeljoseph)(#782)
* Rename the internal function that determines whether a file should be rendered, thanks to [@audreyfeldroy](https://github.com/audreyfeldroy) for raising the issue and [@hackebrot](https://github.com/hackebrot)for the PR (#741, #802)
* Fix typo in docs, thanks to [@mwarkentin](https://github.com/mwarkentin) (#828)
* Fix broken link to *Invoke* docs, thanks to [@B3QL](https://github.com/B3QL) (#820)
* Add documentation to `render_variable` function in `prompt.py`, thanks to [@pydanny](https://github.com/pydanny) (#678)
* Fix python3.6 travis-ci and tox configuration, thanks to [@luzfcb](https://github.com/luzfcb) (#844)
* Add missing encoding declarations to python files, thanks to [@andytom](https://github.com/andytom) (#852)
* Disable poyo logging for tests, thanks to [@hackebrot](https://github.com/hackebrot) (#855)
* Remove pycache directories in make clean-pyc, thanks to [@hackebrot](https://github.com/hackebrot) (#849)
* Refactor hook system to only find the requested hook, thanks to [@michaeljoseph](https://github.com/michaeljoseph) (#834)
* Add tests for custom extensions in `pre_gen_project` and `post_gen_project` hooks, thanks to [@hackebrot](https://github.com/hackebrot) (#856)
* Make the build reproducible by avoiding nondeterministic keyword arguments, thanks to [@lamby](https://github.com/lamby) and [@hackebrot](https://github.com/hackebrot) (#800, #861)
* Extend CLI help message and point users to the github project to engage with the community, thanks to [@hackebrot](https://github.com/hackebrot) (#859)
* Added more cookiecutter templates to the mix:
* [cookiecutter-funkload-friendly](https://github.com/tokibito/cookiecutter-funkload-friendly) by [@tokibito](https://github.com/tokibito) (#657)
* [cookiecutter-reveal.js](https://github.com/keimlink/cookiecutter-reveal.js) by [@keimlink](https://github.com/keimlink) (#660)
* [cookiecutter-python-app](https://github.com/mdklatt/cookiecutter-python-app) by [@mdklatt](https://github.com/mdklatt) (#659)
* [morepath-cookiecutter](https://github.com/morepath/morepath-cookiecutter) by [@href](https://github.com/href) (#672)
* [hovercraft-slides](https://github.com/Springerle/hovercraft-slides) by [@jhermann](https://github.com/jhermann) (#665)
* [cookiecutter-es6-package](https://github.com/ratson/cookiecutter-es6-package) by [@ratson](https://github.com/ratson) (#667)
* [cookiecutter-webpack](https://github.com/hzdg/cookiecutter-webpack) by [@hzdg](https://github.com/hzdg) (#668)
* [cookiecutter-django-herokuapp](https://github.com/dulaccc/cookiecutter-django-herokuapp) by [@dulaccc](https://github.com/dulaccc) (#374)
* [cookiecutter-django-aws-eb](https://github.com/dolphinkiss/cookiecutter-django-aws-eb) by [@peterlauri](https://github.com/peterlauri) (#626)
* [wagtail-starter-kit](https://github.com/tkjone/wagtail-starter-kit) by [@tkjone](https://github.com/tkjone) (#658)
* [cookiecutter-dpf-effect](https://github.com/SpotlightKid/cookiecutter-dpf-effect) by [@SpotlightKid](https://github.com/SpotlightKid) (#663)
* [cookiecutter-dpf-audiotk](https://github.com/SpotlightKid/cookiecutter-dpf-audiotk) by [@SpotlightKid](https://github.com/SpotlightKid) (#663)
* [cookiecutter-template](https://github.com/eviweb/cookiecutter-template) by [@eviweb](https://github.com/eviweb) (#664)
* [cookiecutter-angular2](https://github.com/matheuspoleza/cookiecutter-angular2) by [@matheuspoleza](https://github.com/matheuspoleza) (#675)
* [cookiecutter-data-science](http://drivendata.github.io/cookiecutter-data-science/) by [@pjbull](https://github.com/pjbull) (#680)
* [cc\_django\_ember\_app](https://bitbucket.org/levit_scs/cc_django_ember_app) by [@nanuxbe](https://github.com/nanuxbe) (#686)
* [cc\_project\_app\_drf](https://bitbucket.org/levit_scs/cc_project_app_drf) by [@nanuxbe](https://github.com/nanuxbe) (#686)
* [cc\_project\_app\_full\_with\_hooks](https://bitbucket.org/levit_scs/cc_project_app_full_with_hooks) by [@nanuxbe](https://github.com/nanuxbe) (#686)
* [beat-generator](https://github.com/elastic/beat-generator) by [@ruflin](https://github.com/ruflin) (#695)
* [cookiecutter-scala](https://github.com/Plippe/cookiecutter-scala) by [@Plippe](https://github.com/Plippe) (#751)
* [cookiecutter-snakemake-analysis-pipeline](https://github.com/xguse/cookiecutter-snakemake-analysis-pipeline) by [@xguse](https://github.com/xguse) (#692)
* [cookiecutter-py3tkinter](https://github.com/ivanlyon/cookiecutter-py3tkinter) by [@ivanlyon](https://github.com/ivanlyon) (#730)
* [pyramid-cookiecutter-alchemy](https://github.com/Pylons/pyramid-cookiecutter-alchemy) by [@stevepiercy](https://github.com/stevepiercy) (#745)
* [pyramid-cookiecutter-starter](https://github.com/Pylons/pyramid-cookiecutter-starter) by [@stevepiercy](https://github.com/stevepiercy) (#745)
* [pyramid-cookiecutter-zodb](https://github.com/Pylons/pyramid-cookiecutter-zodb) by [@stevepiercy](https://github.com/stevepiercy) (#745)
* [substanced-cookiecutter](https://github.com/Pylons/substanced-cookiecutter) by [@stevepiercy](https://github.com/stevepiercy) (#745)
* [cookiecutter-simple-django-cn](https://github.com/shenyushun/cookiecutter-simple-django-cn) by [@shenyushun](https://github.com/shenyushun) (#765)
* [cookiecutter-pyqt5](https://github.com/mandeepbhutani/cookiecutter-pyqt5) by [@mandeepbhutani](https://github.com/mandeepbhutani) (#797)
* [cookiecutter-xontrib](https://github.com/laerus/cookiecutter-xontrib) by [@laerus](https://github.com/laerus) (#817)
* [cookiecutter-reproducible-science](https://github.com/mkrapp/cookiecutter-reproducible-science) by [@mkrapp](https://github.com/mkrapp) (#826)
* [cc-automated-drf-template](https://github.com/TAMU-CPT/cc-automated-drf-template) by [@elenimijalis](https://github.com/elenimijalis) (#832)
## 1.4.0 (2016-03-20) Shortbread
The goal of this release is changing to a strict Jinja2 environment, paving the way to more awesome in the future, as well as adding support
for Jinja2 extensions.
New Features:
* Added support for Jinja2 extension support, thanks to [@hackebrot](https://github.com/hackebrot) (#617).
* Now raises an error if Cookiecutter tries to render a template that contains an undefined variable. Makes generation more robust and
secure (#586). Work done by [@hackebrot](https://github.com/hackebrot) (#111, #586, #592)
* Uses strict Jinja2 env in prompt, thanks to [@hackebrot](https://github.com/hackebrot) (#598, #613)
* Switched from pyyaml/ruamel.yaml libraries that were problematic across platforms to the pure Python [poyo](https://pypi.python.org/pypi/poyo) library, thanks to [@hackebrot](https://github.com/hackebrot) (#557, #569, #621)
* User config values for `cookiecutters_dir` and `replay_dir` now support environment variable and user home expansion, thanks to [@nfarrar](https://github.com/nfarrar) for the suggestion and [@hackebrot](https://github.com/hackebrot) for the PR (#640,#642)
* Add [jinja2-time](https://pypi.python.org/pypi/jinja2-time) as default extension for dates and times in templates via `{% now 'utc' %}`,thanks to [@hackebrot](https://github.com/hackebrot) (#653)
Bug Fixes:
* Provided way to define options that have no defaults, thanks to [@johtso](https://github.com/johtso) (#587, #588)
* Make sure that `replay.dump()` and `replay.load()` use the correct user config, thanks to [@hackebrot](https://github.com/hackebrot)
(#590, #594)
* Added correct CA bundle for Git on Appveyor, thanks to [@maiksensi](https://github.com/maiksensi) (#599, #602)
* Open `HISTORY.rst` with `utf-8` encoding when reading the changelog, thanks to [@0-wiz-0](https://github.com/0-wiz-0) for submitting the issue and [@hackebrot](https://github.com/hackebrot) for the fix (#638, #639)
* Fix repository indicators for [privaterepository](http://cookiecutter.readthedocs.io/en/latest/usage.html#works-with-private-repos)
urls, thanks to [@habnabit](https://github.com/habnabit) for the fix (#595) and [@hackebrot](https://github.com/hackebrot) for the
tests (#655)
Other Changes:
* Set path before running tox, thanks to [@maiksensi](https://github.com/maiksensi) (#615, #620)
* Removed xfail in test\_cookiecutters, thanks to [@hackebrot](https://github.com/hackebrot) (#618)
* Removed django-cms-plugin on account of 404 error, thanks to [@mativs](https://github.com/mativs) and [@pydanny](https://github.com/pydanny) (#593)
* Fixed docs/usage.rst, thanks to [@macrotim](https://github.com/macrotim) (#604)
* Update .gitignore to latest Python.gitignore and ignore PyCharm files, thanks to [@audreyfeldroy](https://github.com/audreyfeldroy)
* Use open context manager to read context\_file in generate() function, thanks to [@hackebrot](https://github.com/hackebrot)
(#607, #608)
* Added documentation for choice variables, thanks to [@maiksensi](https://github.com/maiksensi) (#611)
* Set up Scrutinizer to check code quality, thanks to [@audreyfeldroy](https://github.com/audreyfeldroy)
* Drop distutils support in setup.py, thanks to [@hackebrot](https://github.com/hackebrot) (#606, #609)
* Change cookiecutter-pypackage-minimal link, thanks to [@kragniz](https://github.com/kragniz) (#614)
* Fix typo in one of the template\'s description, thanks to [@ryanfreckleton](https://github.com/ryanfreckleton) (#643)
* Fix broken link to [\_copy\_without\_render](http://cookiecutter.readthedocs.io/en/latest/advanced_usage.html#copy-without-render)
in *troubleshooting.rst*, thanks to [@ptim](https://github.com/ptim) (#647)
* Added more cookiecutter templates to the mix:
* [cookiecutter-pipproject](https://github.com/wdm0006/cookiecutter-pipproject) by [@wdm0006](https://github.com/wdm0006) (#624)
* [cookiecutter-flask-2](https://github.com/wdm0006/cookiecutter-flask) by [@wdm0006](https://github.com/wdm0006) (#624)
* [cookiecutter-kotlin-gradle](https://github.com/thomaslee/cookiecutter-kotlin-gradle) by [@thomaslee](https://github.com/thomaslee) (#622)
* [cookiecutter-tryton-fulfilio](https://github.com/fulfilio/cookiecutter-tryton) by [@cedk](https://github.com/cedk) (#631)
* [django-starter](https://github.com/tkjone/django-starter) by [@tkjone](https://github.com/tkjone) (#635)
* [django-docker-bootstrap](https://github.com/legios89/django-docker-bootstrap) by [@legios89](https://github.com/legios89) (#636)
* [cookiecutter-mediawiki-extension](https://github.com/JonasGroeger/cookiecutter-mediawiki-extension) by [@JonasGroeger](https://github.com/JonasGroeger) (#645)
* [cookiecutter-django-gulp](https://github.com/valerymelou/cookiecutter-django-gulp) by [@valerymelou](https://github.com/valerymelou) (#648)
## 1.3.0 (2015-11-10) Pumpkin Spice
The goal of this release is to extend the user config feature and to make hook execution more robust.
New Features:
* Abort project generation if `pre_gen_project` or `post_gen_project` hook scripts fail, thanks to [@eliasdorneles](https://github.com/eliasdorneles) (#464, #549)
* Extend user config capabilities with additional cli options `--config-file` and `--default-config` and environment variable `COOKIECUTTER_CONFIG`, thanks to [@jhermann](https://github.com/jhermann), [@pfmoore](https://github.com/pfmoore), and [@hackebrot](https://github.com/hackebrot) (#258, #424, #565)
Bug Fixes:
* Fixed conditional dependencies for wheels in setup.py, thanks to [@hackebrot](https://github.com/hackebrot) (#557, #568)
* Reverted skipif markers to use correct reasons (bug fixed in pytest), thanks to [@hackebrot](https://github.com/hackebrot)
(#574)
Other Changes:
* Improved path and documentation for rendering the Sphinx documentation, thanks to [@eliasdorneles](https://github.com/eliasdorneles) and [@hackebrot](https://github.com/hackebrot) (#562, #583)
* Added additional help entrypoints, thanks to [@michaeljoseph](https://github.com/michaeljoseph) (#563, #492)
* Added Two Scoops Academy to the README, thanks to [@hackebrot](https://github.com/hackebrot) (#576)
* Now handling trailing slash on URL, thanks to [@ramiroluz](https://github.com/ramiroluz) (#573, #546)
* Support for testing x86 and x86-64 architectures on appveyor, thanks to [@maiksensi](https://github.com/maiksensi) (#567)
* Made tests work without installing Cookiecutter, thanks to [@vincentbernat](https://github.com/vincentbernat) (#550)
* Encoded the result of the hook template to utf8, thanks to [@ionelmc](https://github.com/ionelmc) (#577. #578)
* Added test for \_run\_hook\_from\_repo\_dir, thanks to [@hackebrot](https://github.com/hackebrot) (#579, #580)
* Implemented bumpversion, thanks to [@hackebrot](https://github.com/hackebrot) (#582)
* Added more cookiecutter templates to the mix:
* [cookiecutter-octoprint-plugin](https://github.com/OctoPrint/cookiecutter-octoprint-plugin) by [@foosel](https://github.com/foosel) (#560)
* [wagtail-cookiecutter-foundation](https://github.com/chrisdev/wagtail-cookiecutter-foundation) by [@chrisdev](https://github.com/chrisdev), et al. (#566)
## 1.2.1 (2015-10-18) Zimtsterne
*Zimtsterne are cinnamon star cookies.*
New Feature:
* Returns rendered project dir, thanks to [@hackebrot](https://github.com/hackebrot) (#553)
Bug Fixes:
* Factor in *choice* variables (as introduced in 1.1.0) when using a user config or extra context, thanks to [@ionelmc](https://github.com/ionelmc) and [@hackebrot](https://github.com/hackebrot) (#536, #542).
Other Changes:
* Enable py35 support on Travis by using Python 3.5 as base Python ([@maiksensi](https://github.com/maiksensi) / #540)
* If a filename is empty, do not generate. Log instead ([@iljabauer](https://github.com/iljabauer) / #444)
* Fix tests as per last changes in [cookiecutter-pypackage](https://github.com/audreyfeldroy/cookiecutter-pypackage), thanks to [@eliasdorneles](https://github.com/eliasdorneles)(#555).
* Removed deprecated cookiecutter-pylibrary-minimal from the list, thanks to [@ionelmc](https://github.com/ionelmc) (#556)
* Moved to using rualmel.yaml instead of PyYAML, except for Windows users on Python 2.7, thanks
to [@pydanny](https://github.com/pydanny) (#557)
*Why 1.2.1 instead of 1.2.0? There was a problem in the distribution that we pushed to PyPI. Since you can\'t replace previous files uploaded to PyPI, we deleted the files on PyPI and released 1.2.1.*
## 1.1.0 (2015-09-26) Snickerdoodle
The goals of this release were ```copy without render``` and a few additional command-line options such as ```--overwrite-if-exists```, ```---replay```, and ```output-dir```.
Features:
* Added [copy without render](http://cookiecutter.readthedocs.io/en/latest/advanced_usage.html#copy-without-render) feature, making it much easier for developers of Ansible, Salt Stack, and other recipe-based tools to work with Cookiecutter. Thanks to [@osantana](https://github.com/osantana) and [@LucianU](https://github.com/LucianU) for their innovation, as well as [@hackebrot](https://github.com/hackebrot) for fixing the Windows problems (#132, #184, #425).
* Added specify output directory, thanks to [@tony](https://github.com/tony) and [@hackebrot](https://github.com/hackebrot) (#531, #452).
* Abort template rendering if the project output directory already exists, thanks to [@lgp171188](https://github.com/lgp171188)
(#470, #471).
* Add a flag to overwrite existing output directory, thanks to [@lgp171188](https://github.com/lgp171188) for the implementation (#495) and [@schacki](https://github.com/schacki), [@ionelmc](https://github.com/ionelmc), [@pydanny](https://github.com/pydanny) and [@hackebrot](https://github.com/hackebrot) for submitting issues and code reviews (#475, #493).
* Remove test command in favor of tox, thanks to [@hackebrot](https://github.com/hackebrot) (#480).
* Allow cookiecutter invocation, even without installing it, via `python -m cookiecutter.cli`, thanks to [@vincentbernat](https://github.com/vincentbernat) and [@hackebrot](https://github.com/hackebrot) (#449, #487).
* Improve the type detection handler for online and offline repositories, thanks to [@charlax](https://github.com/charlax)
(#490).
* Add replay feature, thanks to [@hackebrot](https://github.com/hackebrot) (#501).
* Be more precise when raising an error for an invalid user config file, thanks to [@vaab](https://github.com/vaab) and [@hackebrot](https://github.com/hackebrot) (#378, #528).
* Added official Python 3.5 support, thanks to [@pydanny](https://github.com/pydanny) and [@hackebrot](https://github.com/hackebrot) (#522).
* Added support for *choice* variables and switch to click style prompts, thanks to [@hackebrot](https://github.com/hackebrot) (#441, #455).
Other Changes:
* Updated click requirement to \< 6.0, thanks to [@pydanny](https://github.com/pydanny) (#473).
* Added landscape.io flair, thanks to [@michaeljoseph](https://github.com/michaeljoseph) (#439).
* Descriptions of PEP8 specifications and milestone management, thanks to [@michaeljoseph](https://github.com/michaeljoseph) (#440).
* Added alternate installation options in the documentation, thanks to [@pydanny](https://github.com/pydanny) (#117, #315).
* The test of the which() function now tests against the date command, thanks to [@vincentbernat](https://github.com/vincentbernat) (#446)
* Ensure file handles in setup.py are closed using with statement, thanks to [@svisser](https://github.com/svisser) (#280).
* Removed deprecated and fully extraneous compat.is\_exe() function, thanks to [@hackebrot](https://github.com/hackebrot) (#485).
* Disabled sudo in .travis, thanks to [@hackebrot](https://github.com/hackebrot) (#482).
* Switched to shields.io for problematic badges, thanks to [@pydanny](https://github.com/pydanny) (#491).
* Added whichcraft and removed `compat.which()`, thanks to [@pydanny](https://github.com/pydanny) (#511).
* Changed to export tox environment variables to codecov, thanks to [@maiksensi](https://github.com/maiksensi). (#508).
* Moved to using click version command, thanks to [@hackebrot](https://github.com/hackebrot) (#489).
* Don\'t use unicode\_literals to please click, thanks to [@vincentbernat](https://github.com/vincentbernat) (#503).
* Remove warning for Python 2.6 from \_\_init\_\_.py, thanks to [@hackebrot](https://github.com/hackebrot).
* Removed compat.py module, thanks to [@hackebrot](https://github.com/hackebrot).
* Added future to requirements, thanks to [@hackebrot](https://github.com/hackebrot).
* Fixed problem where expanduser does not resolve \"\~\" correctly on windows 10 using tox, thanks to [@maiksensi](https://github.com/maiksensi). (#527)
* Added more cookiecutter templates to the mix:
* [cookiecutter-beamer](https://github.com/luismartingil/cookiecutter-beamer) by [@luismartingil](https://github.com/luismartingil) (#307)
* [cookiecutter-pytest-plugin](https://github.com/pytest-dev/cookiecutter-pytest-plugin) by [@pytest-dev](https://github.com/pytest-dev) and
[@hackebrot](https://github.com/hackebrot) (#481)
* [cookiecutter-csharp-objc-binding](https://github.com/SandyChapman/cookiecutter-csharp-objc-binding) by [@SandyChapman](https://github.com/SandyChapman) (#460)
* [cookiecutter-flask-foundation](https://github.com/JackStouffer/cookiecutter-Flask-Foundation) by [@JackStouffer](https://github.com/JackStouffer) (#457)
* [cookiecutter-tryton-fulfilio](https://github.com/fulfilio/cookiecutter-tryton) by [@fulfilio](https://github.com/fulfilio) (#465)
* [cookiecutter-tapioca](https://github.com/vintasoftware/cookiecutter-tapioca) by [@vintasoftware](https://github.com/vintasoftware) (#496)
* [cookiecutter-sublime-text-3-plugin](https://github.com/kkujawinski/cookiecutter-sublime-text-3-plugin) by [@kkujawinski](https://github.com/kkujawinski) (#500)
* [cookiecutter-muffin](https://github.com/drgarcia1986/cookiecutter-muffin) by [@drgarcia1986](https://github.com/drgarcia1986) (#494)
* [cookiecutter-django-rest](https://github.com/agconti/cookiecutter-django-rest) by [@agconti](https://github.com/agconti) (#520)
* [cookiecutter-es6-boilerplate](https://github.com/agconti/cookiecutter-es6-boilerplate) by [@agconti](https://github.com/agconti) (#521)
* [cookiecutter-tampermonkey](https://github.com/christabor/cookiecutter-tampermonkey) by [@christabor](https://github.com/christabor) (#516)
* [cookiecutter-wagtail](https://github.com/torchbox/cookiecutter-wagtail) by [@torchbox](https://github.com/torchbox) (#533)
## 1.0.0 (2015-03-13) Chocolate Chip
The goals of this release was to formally remove support for Python 2.6 and continue the move to using py.test.
Features:
* Convert the unittest suite to py.test for the sake of comprehensibility, thanks to [@hackebrot](https://github.com/hackebrot) (#322, #332, #334, #336, #337, #338, #340, #341, #343, #345, #347, #351, #412, #413, #414).
* Generate pytest coverage, thanks to [@michaeljoseph](https://github.com/michaeljoseph) (#326).
* Documenting of Pull Request merging and HISTORY.rst maintenance, thanks to [@michaeljoseph](https://github.com/michaeljoseph)
(#330).
* Large expansions to the tutorials thanks to [@hackebrot](https://github.com/hackebrot) (#384)
* Switch to using Click for command-line options, thanks to [@michaeljoseph](https://github.com/michaeljoseph) (#391, #393).
* Added support for working with private repos, thanks to [@marctc](https://github.com/marctc) (#265).
* Wheel configuration thanks to [@michaeljoseph](https://github.com/michaeljoseph) (#118).
Other Changes:
* Formally removed support for 2.6, thanks to [@pydanny](https://github.com/pydanny) (#201).
* Moved to codecov for continuous integration test coverage and badges, thanks to [@michaeljoseph](https://github.com/michaeljoseph) (#71, #369).
* Made JSON parsing errors easier to debug, thanks to [@rsyring](https://github.com/rsyring) and [@mark0978](https://github.com/mark0978) (#355, #358, #388).
* Updated to Jinja 2.7 or higher in order to control trailing new lines in templates, thanks to [@sfermigier](https://github.com/sfermigier) (#356).
* Tweaked flake8 to ignore e731, thanks to [@michaeljoseph](https://github.com/michaeljoseph) (#390).
* Fixed failing Windows tests and corrected AppVeyor badge link thanks to [@msabramo](https://github.com/msabramo) (#403).
* Added more Cookiecutters to the list:
* [cookiecutter-scala-spark](https://github.com/jpzk/cookiecutter-scala-spark) by [@jpzk](https://github.com/jpzk)
* [cookiecutter-atari2600](https://github.com/joeyjoejoejr/cookiecutter-atari2600) by [@joeyjoejoejr](https://github.com/joeyjoejoejr)
* [cookiecutter-bottle](https://github.com/avelino/cookiecutter-bottle) by [@avelino](https://github.com/avelino)
* [cookiecutter-latex-article](https://github.com/Kreger51/cookiecutter-latex-article) by [@Kreger51](https://github.com/Kreger51)
* [cookiecutter-django-rest-framework](https://github.com/jpadilla/cookiecutter-django-rest-framework) by [@jpadilla](https://github.com/jpadilla)
* [cookiedozer](https://github.com/hackebrot/cookiedozer) by [@hackebrot](https://github.com/hackebrot)
## 0.9.0 (2015-01-13)
The goals of this release were to add the ability to Jinja2ify the cookiecutter.json default values, and formally launch support for Python 3.4.
Features:
* Python 3.4 is now a first class citizen, thanks to everyone.
* cookiecutter.json values are now rendered Jinja2 templates, thanks to \@bollwyvl (#291).
* Move to py.test, thanks to [@pfmoore](https://github.com/pfmoore) (#319) and [@ramiroluz](https://github.com/ramiroluz) (#310).
* Add PendingDeprecation warning for users of Python 2.6, as support for it is gone in Python 2.7, thanks to [@michaeljoseph](https://github.com/michaeljoseph) (#201).
Bug Fixes:
* Corrected typo in Makefile, thanks to [@inglesp](https://github.com/inglesp) (#297).
* Raise an exception when users don\'t have git or hg installed, thanks to [@pydanny](https://github.com/pydanny) (#303).
Other changes:
* Creation of [gitter](https://gitter.im/audreyr/cookiecutter) account for logged chat, thanks to [@michaeljoseph](https://github.com/michaeljoseph).
* Added ReadTheDocs badge, thanks to [@michaeljoseph](https://github.com/michaeljoseph).
* Added AppVeyor badge, thanks to [@pydanny](https://github.com/pydanny)
* Documentation and PyPI trove classifier updates, thanks to [@thedrow](https://github.com/thedrow) (#323 and #324)
## 0.8.0 (2014-10-30)
The goal of this release was to allow for injection of extra context via the Cookiecutter API, and to fix minor bugs.
Features:
* cookiecutter() now takes an optional extra\_context parameter, thanks to [@michaeljoseph](https://github.com/michaeljoseph), [@fcurella](https://github.com/fcurella), [@aventurella](https://github.com/aventurella), [@emonty](https://github.com/emonty), [@schacki](https://github.com/schacki), [@ryanolson](https://github.com/ryanolson), [@pfmoore](https://github.com/pfmoore), [@pydanny](https://github.com/pydanny), [@audreyfeldroy](https://github.com/audreyfeldroy) (#260).
* Context is now injected into hooks, thanks to [@michaeljoseph](https://github.com/michaeljoseph) and [@dinopetrone](https://github.com/dinopetrone).
* Moved all Python 2/3 compatibility code into cookiecutter.compat, making the eventual move to six easier, thanks to [@michaeljoseph](https://github.com/michaeljoseph) (#60, #102).
* Added cookiecutterrc defined aliases for cookiecutters, thanks to [@pfmoore](https://github.com/pfmoore) (#246)
* Added flake8 to tox to check for pep8 violations, thanks to [@natim](https://github.com/Natim).
Bug Fixes:
* Newlines at the end of files are no longer stripped, thanks to [@treyhunner](https://github.com/treyhunner) (#183).
* Cloning prompt suppressed by respecting the ```no\_input``` flag, thanks to [@trustrachel](https://github.com/trustrachel) (#285)
* With Python 3, input is no longer converted to bytes, thanks to [@uranusjr](https://github.com/uranusjr) (#98).
Other Changes:
* Added more Cookiecutters to the list:
* [Python-iOS-template](https://github.com/pybee/Python-iOS-template) by [@freakboy3742](https://github.com/freakboy3742)
* [Python-Android-template](https://github.com/pybee/Python-Android-template) by [@freakboy3742](https://github.com/freakboy3742)
* [cookiecutter-djangocms-plugin](https://github.com/mishbahr/cookiecutter-djangocms-plugin) by [@mishbahr](https://github.com/mishbahr)
* [cookiecutter-pyvanguard](https://github.com/robinandeer/cookiecutter-pyvanguard) by [@robinandeer](https://github.com/robinandeer)
## 0.7.2 (2014-08-05)
The goal of this release was to fix cross-platform compatibility, primarily Windows bugs that had crept in during the addition of new
features. As of this release, Windows is a first-class citizen again, now complete with continuous integration.
Bug Fixes:
* Fixed the contributing file so it displays nicely in Github, thanks to [@pydanny](https://github.com/pydanny).
* Updates 2.6 requirements to include simplejson, thanks to [@saxix](https://github.com/saxix).
* Avoid unwanted extra spaces in string literal, thanks to [@merwok](https://github.com/merwok).
* Fix @unittest.skipIf error on Python 2.6.
* Let sphinx parse :param: properly by inserting newlines #213, thanks to [@mineo](https://github.com/mineo).
* Fixed Windows test prompt failure by replacing stdin per [@cjrh](https://github.com/cjrh) in #195.
* Made rmtree remove readonly files, thanks to [@pfmoore](https://github.com/pfmoore).
* Now using tox to run tests on Appveyor, thanks to [@pfmoore](https://github.com/pfmoore) (#241).
* Fixed tests that assumed the system encoding was utf-8, thanks to [@pfmoore](https://github.com/pfmoore) (#242, #244).
* Added a tox ini file that uses py.test, thanks to [@pfmoore](https://github.com/pfmoore) (#245).
Other Changes:
* [@audreyfeldroy](https://github.com/audreyfeldroy) formally accepted position as **BDFL of cookiecutter**.
* Elevated [@pydanny](https://github.com/pydanny), [@michaeljoseph](https://github.com/michaeljoseph), and [@pfmoore](https://github.com/pfmoore) to core committer status.
* Added Core Committer guide, by [@audreyfeldroy](https://github.com/audreyfeldroy).
* Generated apidocs from make docs, by [@audreyfeldroy](https://github.com/audreyfeldroy).
* Added contributing command to the makedocs function, by [@pydanny](https://github.com/pydanny).
* Refactored contributing documentation, included adding core committer instructions, by [@pydanny](https://github.com/pydanny) and [@audreyfeldroy](https://github.com/audreyfeldroy).
* Do not convert input prompt to bytes, thanks to [@uranusjr](https://github.com/uranusjr) (#192).
* Added troubleshooting info about Python 3.3 tests and tox.
* Added documentation about command line arguments, thanks to [@saxix](https://github.com/saxix).
* Style cleanups.
* Added environment variable to disable network tests for environments without networking, thanks to [@vincentbernat](https://github.com/vincentbernat).
* Added Appveyor support to aid Windows integrations, thanks to [@pydanny](https://github.com/pydanny) (#215).
* CONTRIBUTING.rst is now generated via make contributing, thanks to [@pydanny](https://github.com/pydanny) (#220).
* Removed unnecessary endoing argument to json.load, thanks to [@pfmoore](https://github.com/pfmoore) (#234).
* Now generating shell hooks dynamically for Unix/Windows portability, thanks to [@pfmoore](https://github.com/pfmoore) (#236).
* Removed non-portable assumptions about directory structure, thanks to [@pfmoore](https://github.com/pfmoore) (#238).
* Added a note on portability to the hooks documentation, thanks to [@pfmoore](https://github.com/pfmoore) (#239).
* Replaced unicode\_open with direct use of io.open, thanks to [@pfmoore](https://github.com/pfmoore) (#229).
* Added more Cookiecutters to the list:
* [cookiecutter-kivy](https://github.com/hackebrot/cookiecutter-kivy) by [@hackebrot](https://github.com/hackebrot)
* [BoilerplatePP](https://github.com/Paspartout/BoilerplatePP) by [@Paspartout](https://github.com/Paspartout)
* [cookiecutter-pypackage-minimal](https://github.com/kragniz/cookiecutter-pypackage-minimal) by [@borntyping](https://github.com/borntyping)
* [cookiecutter-ansible-role](https://github.com/iknite/cookiecutter-ansible-role) by [@iknite](https://github.com/iknite)
* [cookiecutter-pylibrary](https://github.com/ionelmc/cookiecutter-pylibrary) by [@ionelmc](https://github.com/ionelmc)
* [cookiecutter-pylibrary-minimal](https://github.com/ionelmc/cookiecutter-pylibrary-minimal) by [@ionelmc](https://github.com/ionelmc)
## 0.7.1 (2014-04-26)
Bug fixes:
* Use the current Python interpreter to run Python hooks, thanks to [@coderanger](https://github.com/coderanger).
* Include tests and documentation in source distribution, thanks to [@vincentbernat](https://github.com/vincentbernat).
* Fix various warnings and missing things in the docs (#129, #130), thanks to [@nedbat](https://github.com/nedbat).
* Add command line option to get version (#89), thanks to [@davedash](https://github.com/davedash) and [@cyberj](https://github.com/cyberj).
Other changes:
* Add more Cookiecutters to the list:
* [cookiecutter-avr](https://github.com/solarnz/cookiecutter-avr) by [@solarnz](https://github.com/solarnz)
* [cookiecutter-tumblr-theme](https://github.com/relekang/cookiecutter-tumblr-theme) by [@relekang](https://github.com/relekang)
* [cookiecutter-django-paas](https://github.com/pbacterio/cookiecutter-django-paas) by [@pbacterio](https://github.com/pbacterio)
## 0.7.0 (2013-11-09)
This is a release with significant improvements and changes. Please read through this list before you upgrade.
New features:
* Support for \--checkout argument, thanks to [@foobacca](https://github.com/foobacca/).
* Support for pre-generate and post-generate hooks, thanks to [@raphigaziano](https://github.com/raphigaziano/). Hooks are Python or shell scripts that run before and/or after your project is generated.
* Support for absolute paths to cookiecutters, thanks to [@krallin](https://github.com/krallin/).
* Support for Mercurial version control system, thanks to [@pokoli](https://github.com/pokoli/).
* When a cookiecutter contains invalid Jinja2 syntax, you get a better message that shows the location of the TemplateSyntaxError. Thanks
to [@benjixx](https://github.com/benjixx/).
* Can now prompt the user to enter values during generation from a local cookiecutter, thanks to [@ThomasChiroux](https://github.com/ThomasChiroux/). This is now always the default behavior. Prompts can also be suppressed with ```--no-input```.
* Your cloned cookiecutters are stored by default in your ~/.cookiecutters/ directory (or Windows equivalent). The location is configurable. (This is a major change from the pre-0.7.0 behavior, where cloned cookiecutters were deleted at the end of project generation.) Thanks [@raphigaziano](https://github.com/raphigaziano/).
* User config in a \~/.cookiecutterrc file, thanks to [@raphigaziano](https://github.com/raphigaziano/). Configurable settings are cookiecutters\_dir and default\_context.
* File permissions are now preserved during project generation, thanks to [@benjixx](https://github.com/benjixx/).
Bug fixes:
* Unicode issues with prompts and answers are fixed, thanks to [@s-m-i-t-a](https://github.com/s-m-i-t-a/).
* The test suite now runs on Windows, which was a major effort. Thanks to [@pydanny](https://github.com/pydanny), who collaborated on this with me.
Other changes:
* Quite a bit of refactoring and API changes.
* Lots of documentation improvements. Thanks [@sloria](https://github.com/sloria/), [@alex](https://github.com/alex/), [@pydanny](https://github.com/pydanny), [@freakboy3742](https://github.com/freakboy3742), [@es128](https://github.com/es128/), [@rolo](https://github.com/rolo/).
* Better naming and organization of test suite.
* A CookiecutterCleanSystemTestCase to use for unit tests affected by the user\'s config and cookiecutters directory.
* Improvements to the project\'s Makefile.
* Improvements to tests. Thanks [@gperetin](https://github.com/gperetin/), [@s-m-i-t-a](https://github.com/s-m-i-t-a/).
* Removal of subprocess32 dependency. Now using non-context manager version of subprocess.Popen for Python 2 compatibility.
* Removal of cookiecutter\'s cleanup module.
* A bit of setup.py cleanup, thanks to [@oubiga](https://github.com/oubiga/).
* Now depends on binaryornot 0.2.0.
## 0.6.4 (2013-08-21)
* Windows support officially added.
* Fix TemplateNotFound Exception on Windows (#37).
## 0.6.3 (2013-08-20)
* Fix copying of binary files in nested paths (#41), thanks to [@sloria](https://github.com/sloria/).
## 0.6.2 (2013-08-19)
* Depend on Jinja2\>=2.4 instead of Jinja2==2.7.
* Fix errors on attempt to render binary files. Copy them over from the project template without rendering.
* Fix Python 2.6/2.7 UnicodeDecodeError when values containing Unicode chars are in cookiecutter.json.
* Set encoding in Python 3 unicode_open() to always be utf-8.
## 0.6.1 (2013-08-12)
* Improved project template finding. Now looks for the occurrence of {{,cookiecutter, and }} in a directory name.
* Fix help message for input_dir arg at command prompt.
* Minor edge cases found and corrected, as a result of improved test coverage.
## 0.6.0 (2013-08-08)
* Config is now in a single ```cookiecutter.json``` instead of in ```json/```.
* When you create a project from a git repo template, Cookiecutter prompts you to enter custom values for the fields defined in ```cookiecutter.json```.
## 0.5 (2013-07-28)
* Friendlier, more simplified command line usage:
```bash
# Create project from the cookiecutter-pypackage/ template
$ cookiecutter cookiecutter-pypackage/
# Create project from the cookiecutter-pypackage.git repo template
$ cookiecutter https://github.com/audreyfeldroy/cookiecutter-pypackage.git
```
* Can now use Cookiecutter from Python as a package:
```python
from cookiecutter.main import cookiecutter
# Create project from the cookiecutter-pypackage/ template
cookiecutter('cookiecutter-pypackage/')
# Create project from the cookiecutter-pypackage.git repo template
cookiecutter('https://github.com/audreyfeldroy/cookiecutter-pypackage.git')
```
* Internal refactor to remove any code that changes the working
directory.
## 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.
cookiecutter-2.6.0/LICENSE 0000664 0000000 0000000 00000002725 14565433335 0015245 0 ustar 00root root 0000000 0000000 Copyright (c) 2013-2022, Audrey Roy Greenfeld
All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following
conditions are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided
with the distribution.
* Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
cookiecutter-2.6.0/MANIFEST.in 0000664 0000000 0000000 00000000631 14565433335 0015770 0 ustar 00root root 0000000 0000000 include AUTHORS.md
include CODE_OF_CONDUCT.md
include CONTRIBUTING.md
include HISTORY.md
include LICENSE
include README.md
include cookiecutter/VERSION.txt
exclude Makefile
exclude __main__.py
exclude .*
exclude codecov.yml
exclude test_requirements.txt
exclude tox.ini
recursive-include tests *
recursive-exclude * __pycache__
recursive-exclude * *.py[co]
recursive-exclude docs *
recursive-exclude logo *
cookiecutter-2.6.0/Makefile 0000664 0000000 0000000 00000004753 14565433335 0015703 0 ustar 00root root 0000000 0000000 PYPI_SERVER = pypitest
define BROWSER_PYSCRIPT
import os, webbrowser, sys
try:
from urllib import pathname2url
except:
from urllib.request import pathname2url
webbrowser.open("file://" + pathname2url(os.path.abspath(sys.argv[1])))
endef
export BROWSER_PYSCRIPT
BROWSER := python -c "$$BROWSER_PYSCRIPT"
.DEFAULT_GOAL := help
.PHONY: clean-tox
clean-tox: ## Remove tox testing artifacts
@echo "+ $@"
@rm -rf .tox/
.PHONY: clean-coverage
clean-coverage: ## Remove coverage reports
@echo "+ $@"
@rm -rf htmlcov/
@rm -rf .coverage
@rm -rf coverage.xml
.PHONY: clean-pytest
clean-pytest: ## Remove pytest cache
@echo "+ $@"
@rm -rf .pytest_cache/
.PHONY: clean-docs-build
clean-docs-build: ## Remove local docs
@echo "+ $@"
@rm -rf docs/_build
.PHONY: clean-build
clean-build: ## Remove build artifacts
@echo "+ $@"
@rm -fr build/
@rm -fr dist/
@rm -fr *.egg-info
.PHONY: clean-pyc
clean-pyc: ## Remove Python file artifacts
@echo "+ $@"
@find . -type d -name '__pycache__' -exec rm -rf {} +
@find . -type f -name '*.py[co]' -exec rm -f {} +
@find . -name '*~' -exec rm -f {} +
.PHONY: clean ## Remove all file artifacts
clean: clean-build clean-pyc clean-tox clean-coverage clean-pytest clean-docs-build
.PHONY: lint
lint: ## Check code style
@echo "+ $@"
@tox -e lint
.PHONY: test
test: ## Run tests quickly with the default Python
@echo "+ $@"
@tox -e py310
.PHONY: test-all
test-all: ## Run tests on every Python version
@echo "+ $@"
@tox
.PHONY: coverage
coverage: ## Check code coverage quickly with the default Python
@echo "+ $@"
@tox -e py310
@$(BROWSER) htmlcov/index.html
.PHONY: docs
docs: ## Generate Sphinx HTML documentation, including API docs
@echo "+ $@"
@tox -e docs
@$(BROWSER) docs/_build/html/index.html
.PHONY: servedocs
servedocs: ## Rebuild docs automatically
@echo "+ $@"
@tox -e servedocs
.PHONY: submodules
submodules: ## Pull and update git submodules recursively
@echo "+ $@"
@git pull --recurse-submodules
@git submodule update --init --recursive
.PHONY: release
release: clean ## Package and upload release
@echo "+ $@"
@python -m build
@twine upload -r $(PYPI_SERVER) dist/*
.PHONY: sdist
sdist: clean ## Build sdist distribution
@echo "+ $@"
@python -m build --sdist
@ls -l dist
.PHONY: wheel
wheel: clean ## Build wheel distribution
@echo "+ $@"
@python -m build --wheel
@ls -l dist
.PHONY: help
help:
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-16s\033[0m %s\n", $$1, $$2}'
cookiecutter-2.6.0/README.md 0000664 0000000 0000000 00000012525 14565433335 0015516 0 ustar 00root root 0000000 0000000
# Cookiecutter
Create projects swiftly from **cookiecutters** (project templates) with this command-line utility. Ideal for generating Python package projects and more.
- [Documentation](https://cookiecutter.readthedocs.io)
- [GitHub](https://github.com/cookiecutter/cookiecutter)
- [PyPI](https://pypi.org/project/cookiecutter/)
- [License (BSD)](https://github.com/cookiecutter/cookiecutter/blob/main/LICENSE)
## Installation
Install cookiecutter using pip package manager:
```
# pipx is strongly recommended.
pipx install cookiecutter
# If pipx is not an option,
# you can install cookiecutter in your Python user directory.
python -m pip install --user cookiecutter
```
## Features
- **Cross-Platform:** Supports Windows, Mac, and Linux.
- **User-Friendly:** No Python knowledge required.
- **Versatile:** Compatible with Python 3.7 to 3.12.
- **Multi-Language Support:** Use templates in any language or markup format.
### For Users
#### Quick Start
The recommended way to use Cookiecutter as a command line utility is to run it with [`pipx`](https://pypa.github.io/pipx/), which can be installed with `pip install pipx`, but if you plan to use Cookiecutter programmatically, please run `pip install cookiecutter`.
**Use a GitHub template**
```bash
# You'll be prompted to enter values.
# Then it'll create your Python package in the current working directory,
# based on those values.
# For the sake of brevity, repos on GitHub can just use the 'gh' prefix
$ pipx run cookiecutter gh:audreyfeldroy/cookiecutter-pypackage
```
**Use a local template**
```bash
$ pipx run cookiecutter cookiecutter-pypackage/
```
**Use it from Python**
```py
from cookiecutter.main import cookiecutter
# Create project from the cookiecutter-pypackage/ template
cookiecutter('cookiecutter-pypackage/')
# Create project from the cookiecutter-pypackage.git repo template
cookiecutter('gh:audreyfeldroy//cookiecutter-pypackage.git')
```
#### Detailed Usage
- Generate projects from local or remote templates.
- Customize projects with `cookiecutter.json` prompts.
- Utilize pre-prompt, pre- and post-generate hooks.
[Learn More](https://cookiecutter.readthedocs.io/en/latest/usage.html)
### For Template Creators
- Utilize unlimited directory nesting.
- Employ Jinja2 for all templating needs.
- Define template variables easily with `cookiecutter.json`.
[Learn More](https://cookiecutter.readthedocs.io/en/latest/tutorials/)
## Available Templates
Discover a variety of ready-to-use templates on [GitHub](https://github.com/search?q=cookiecutter&type=Repositories).
### Special Templates
- [cookiecutter-pypackage](https://github.com/audreyfeldroy/cookiecutter-pypackage)
- [cookiecutter-django](https://github.com/pydanny/cookiecutter-django)
- [cookiecutter-pytest-plugin](https://github.com/pytest-dev/cookiecutter-pytest-plugin)
- [cookiecutter-plone-starter](https://github.com/collective/cookiecutter-plone-starter)
## Community
Join the community, contribute, or seek assistance.
- [Troubleshooting Guide](https://cookiecutter.readthedocs.io/en/latest/troubleshooting.html)
- [Stack Overflow](https://stackoverflow.com/questions/tagged/cookiecutter)
- [Discord](https://discord.gg/9BrxzPKuEW)
- [File an Issue](https://github.com/cookiecutter/cookiecutter/issues?q=is%3Aopen)
- [Contributors](AUTHORS.md)
- [Contribution Guide](CONTRIBUTING.md)
### Support
- Star us on [GitHub](https://github.com/cookiecutter/cookiecutter).
- Stay tuned for upcoming support options.
### Feedback
We value your feedback. Share your criticisms or complaints constructively to help us improve.
- [File an Issue](https://github.com/cookiecutter/cookiecutter/issues?q=is%3Aopen)
### Waiting for a Response?
- Be patient and consider reaching out to the community for assistance.
- For urgent matters, contact [@audreyfeldroy](https://github.com/audreyfeldroy) for consultation or custom development.
## Code of Conduct
Adhere to the [PyPA Code of Conduct](https://www.pypa.io/en/latest/code-of-conduct/) during all interactions in the project's ecosystem.
## Acknowledgements
Created and led by [Audrey Roy Greenfeld](https://github.com/audreyfeldroy), supported by a dedicated team of maintainers and contributors.
cookiecutter-2.6.0/__main__.py 0000664 0000000 0000000 00000000253 14565433335 0016324 0 ustar 00root root 0000000 0000000 """Allow cookiecutter to be executable from a checkout or zip file."""
import runpy
if __name__ == "__main__":
runpy.run_module("cookiecutter", run_name="__main__")
cookiecutter-2.6.0/codecov.yml 0000664 0000000 0000000 00000000121 14565433335 0016371 0 ustar 00root root 0000000 0000000 # comment spam as user can always click the failed coverage check
comment: false
cookiecutter-2.6.0/cookiecutter/ 0000775 0000000 0000000 00000000000 14565433335 0016732 5 ustar 00root root 0000000 0000000 cookiecutter-2.6.0/cookiecutter/VERSION.txt 0000664 0000000 0000000 00000000006 14565433335 0020614 0 ustar 00root root 0000000 0000000 2.6.0
cookiecutter-2.6.0/cookiecutter/__init__.py 0000664 0000000 0000000 00000000476 14565433335 0021052 0 ustar 00root root 0000000 0000000 """Main package for Cookiecutter."""
from pathlib import Path
def _get_version() -> str:
"""Read VERSION.txt and return its contents."""
path = Path(__file__).parent.resolve()
version_file = path / "VERSION.txt"
return version_file.read_text(encoding="utf-8").strip()
__version__ = _get_version()
cookiecutter-2.6.0/cookiecutter/__main__.py 0000664 0000000 0000000 00000000302 14565433335 0021017 0 ustar 00root root 0000000 0000000 """Allow cookiecutter to be executable through `python -m cookiecutter`."""
from cookiecutter.cli import main
if __name__ == "__main__": # pragma: no cover
main(prog_name="cookiecutter")
cookiecutter-2.6.0/cookiecutter/cli.py 0000664 0000000 0000000 00000016230 14565433335 0020055 0 ustar 00root root 0000000 0000000 """Main `cookiecutter` CLI."""
import collections
import json
import os
import sys
import click
from cookiecutter import __version__
from cookiecutter.config import get_user_config
from cookiecutter.exceptions import (
ContextDecodingException,
FailedHookException,
InvalidModeException,
InvalidZipRepository,
OutputDirExistsException,
RepositoryCloneFailed,
RepositoryNotFound,
UndefinedVariableInTemplate,
UnknownExtension,
)
from cookiecutter.log import configure_logger
from cookiecutter.main import cookiecutter
def version_msg():
"""Return the Cookiecutter version, location and Python powering it."""
python_version = sys.version
location = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
return f"Cookiecutter {__version__} from {location} (Python {python_version})"
def validate_extra_context(ctx, param, value):
"""Validate extra context."""
for string in value:
if '=' not in string:
raise click.BadParameter(
f"EXTRA_CONTEXT should contain items of the form key=value; "
f"'{string}' doesn't match that form"
)
# Convert tuple -- e.g.: ('program_name=foobar', 'startsecs=66')
# to dict -- e.g.: {'program_name': 'foobar', 'startsecs': '66'}
return collections.OrderedDict(s.split('=', 1) for s in value) or None
def list_installed_templates(default_config, passed_config_file):
"""List installed (locally cloned) templates. Use cookiecutter --list-installed."""
config = get_user_config(passed_config_file, default_config)
cookiecutter_folder = config.get('cookiecutters_dir')
if not os.path.exists(cookiecutter_folder):
click.echo(
f"Error: Cannot list installed templates. "
f"Folder does not exist: {cookiecutter_folder}"
)
sys.exit(-1)
template_names = [
folder
for folder in os.listdir(cookiecutter_folder)
if os.path.exists(
os.path.join(cookiecutter_folder, folder, 'cookiecutter.json')
)
]
click.echo(f'{len(template_names)} installed templates: ')
for name in template_names:
click.echo(f' * {name}')
@click.command(context_settings=dict(help_option_names=['-h', '--help']))
@click.version_option(__version__, '-V', '--version', message=version_msg())
@click.argument('template', required=False)
@click.argument('extra_context', nargs=-1, callback=validate_extra_context)
@click.option(
'--no-input',
is_flag=True,
help='Do not prompt for parameters and only use cookiecutter.json file content. '
'Defaults to deleting any cached resources and redownloading them. '
'Cannot be combined with the --replay flag.',
)
@click.option(
'-c',
'--checkout',
help='branch, tag or commit to checkout after git clone',
)
@click.option(
'--directory',
help='Directory within repo that holds cookiecutter.json file '
'for advanced repositories with multi templates in it',
)
@click.option(
'-v', '--verbose', is_flag=True, help='Print debug information', default=False
)
@click.option(
'--replay',
is_flag=True,
help='Do not prompt for parameters and only use information entered previously. '
'Cannot be combined with the --no-input flag or with extra configuration passed.',
)
@click.option(
'--replay-file',
type=click.Path(),
default=None,
help='Use this file for replay instead of the default.',
)
@click.option(
'-f',
'--overwrite-if-exists',
is_flag=True,
help='Overwrite the contents of the output directory if it already exists',
)
@click.option(
'-s',
'--skip-if-file-exists',
is_flag=True,
help='Skip the files in the corresponding directories if they already exist',
default=False,
)
@click.option(
'-o',
'--output-dir',
default='.',
type=click.Path(),
help='Where to output the generated project dir into',
)
@click.option(
'--config-file', type=click.Path(), default=None, help='User configuration file'
)
@click.option(
'--default-config',
is_flag=True,
help='Do not load a config file. Use the defaults instead',
)
@click.option(
'--debug-file',
type=click.Path(),
default=None,
help='File to be used as a stream for DEBUG logging',
)
@click.option(
'--accept-hooks',
type=click.Choice(['yes', 'ask', 'no']),
default='yes',
help='Accept pre/post hooks',
)
@click.option(
'-l', '--list-installed', is_flag=True, help='List currently installed templates.'
)
@click.option(
'--keep-project-on-failure',
is_flag=True,
help='Do not delete project folder on failure',
)
def main(
template,
extra_context,
no_input,
checkout,
verbose,
replay,
overwrite_if_exists,
output_dir,
config_file,
default_config,
debug_file,
directory,
skip_if_file_exists,
accept_hooks,
replay_file,
list_installed,
keep_project_on_failure,
):
"""Create a project from a Cookiecutter project template (TEMPLATE).
Cookiecutter is free and open source software, developed and managed by
volunteers. If you would like to help out or fund the project, please get
in touch at https://github.com/cookiecutter/cookiecutter.
"""
# Commands that should work without arguments
if list_installed:
list_installed_templates(default_config, config_file)
sys.exit(0)
# Raising usage, after all commands that should work without args.
if not template or template.lower() == 'help':
click.echo(click.get_current_context().get_help())
sys.exit(0)
configure_logger(stream_level='DEBUG' if verbose else 'INFO', debug_file=debug_file)
# If needed, prompt the user to ask whether or not they want to execute
# the pre/post hooks.
if accept_hooks == "ask":
_accept_hooks = click.confirm("Do you want to execute hooks?")
else:
_accept_hooks = accept_hooks == "yes"
if replay_file:
replay = replay_file
try:
cookiecutter(
template,
checkout,
no_input,
extra_context=extra_context,
replay=replay,
overwrite_if_exists=overwrite_if_exists,
output_dir=output_dir,
config_file=config_file,
default_config=default_config,
password=os.environ.get('COOKIECUTTER_REPO_PASSWORD'),
directory=directory,
skip_if_file_exists=skip_if_file_exists,
accept_hooks=_accept_hooks,
keep_project_on_failure=keep_project_on_failure,
)
except (
ContextDecodingException,
OutputDirExistsException,
InvalidModeException,
FailedHookException,
UnknownExtension,
InvalidZipRepository,
RepositoryNotFound,
RepositoryCloneFailed,
) as e:
click.echo(e)
sys.exit(1)
except UndefinedVariableInTemplate as undefined_err:
click.echo(f'{undefined_err.message}')
click.echo(f'Error message: {undefined_err.error.message}')
context_str = json.dumps(undefined_err.context, indent=4, sort_keys=True)
click.echo(f'Context: {context_str}')
sys.exit(1)
if __name__ == "__main__":
main()
cookiecutter-2.6.0/cookiecutter/config.py 0000664 0000000 0000000 00000011240 14565433335 0020547 0 ustar 00root root 0000000 0000000 """Global configuration handling."""
import collections
import copy
import logging
import os
import yaml
from cookiecutter.exceptions import ConfigDoesNotExistException, InvalidConfiguration
logger = logging.getLogger(__name__)
USER_CONFIG_PATH = os.path.expanduser('~/.cookiecutterrc')
BUILTIN_ABBREVIATIONS = {
'gh': 'https://github.com/{0}.git',
'gl': 'https://gitlab.com/{0}.git',
'bb': 'https://bitbucket.org/{0}',
}
DEFAULT_CONFIG = {
'cookiecutters_dir': os.path.expanduser('~/.cookiecutters/'),
'replay_dir': os.path.expanduser('~/.cookiecutter_replay/'),
'default_context': collections.OrderedDict([]),
'abbreviations': BUILTIN_ABBREVIATIONS,
}
def _expand_path(path):
"""Expand both environment variables and user home in the given path."""
path = os.path.expandvars(path)
path = os.path.expanduser(path)
return path
def merge_configs(default, overwrite):
"""Recursively update a dict with the key/value pair of another.
Dict values that are dictionaries themselves will be updated, whilst
preserving existing keys.
"""
new_config = copy.deepcopy(default)
for k, v in overwrite.items():
# Make sure to preserve existing items in
# nested dicts, for example `abbreviations`
if isinstance(v, dict):
new_config[k] = merge_configs(default.get(k, {}), v)
else:
new_config[k] = v
return new_config
def get_config(config_path):
"""Retrieve the config from the specified path, returning a config dict."""
if not os.path.exists(config_path):
raise ConfigDoesNotExistException(f'Config file {config_path} does not exist.')
logger.debug('config_path is %s', config_path)
with open(config_path, encoding='utf-8') as file_handle:
try:
yaml_dict = yaml.safe_load(file_handle) or {}
except yaml.YAMLError as e:
raise InvalidConfiguration(
f'Unable to parse YAML file {config_path}.'
) from e
if not isinstance(yaml_dict, dict):
raise InvalidConfiguration(
f'Top-level element of YAML file {config_path} should be an object.'
)
config_dict = merge_configs(DEFAULT_CONFIG, yaml_dict)
raw_replay_dir = config_dict['replay_dir']
config_dict['replay_dir'] = _expand_path(raw_replay_dir)
raw_cookies_dir = config_dict['cookiecutters_dir']
config_dict['cookiecutters_dir'] = _expand_path(raw_cookies_dir)
return config_dict
def get_user_config(config_file=None, default_config=False):
"""Return the user config as a dict.
If ``default_config`` is True, ignore ``config_file`` and return default
values for the config parameters.
If ``default_config`` is a dict, merge values with default values and return them
for the config parameters.
If a path to a ``config_file`` is given, that is different from the default
location, load the user config from that.
Otherwise look up the config file path in the ``COOKIECUTTER_CONFIG``
environment variable. If set, load the config from this path. This will
raise an error if the specified path is not valid.
If the environment variable is not set, try the default config file path
before falling back to the default config values.
"""
# Do NOT load a config. Merge provided values with defaults and return them instead
if default_config and isinstance(default_config, dict):
return merge_configs(DEFAULT_CONFIG, default_config)
# Do NOT load a config. Return defaults instead.
if default_config:
logger.debug("Force ignoring user config with default_config switch.")
return copy.copy(DEFAULT_CONFIG)
# Load the given config file
if config_file and config_file is not USER_CONFIG_PATH:
logger.debug("Loading custom config from %s.", config_file)
return get_config(config_file)
try:
# Does the user set up a config environment variable?
env_config_file = os.environ['COOKIECUTTER_CONFIG']
except KeyError:
# Load an optional user config if it exists
# otherwise return the defaults
if os.path.exists(USER_CONFIG_PATH):
logger.debug("Loading config from %s.", USER_CONFIG_PATH)
return get_config(USER_CONFIG_PATH)
else:
logger.debug("User config not found. Loading default config.")
return copy.copy(DEFAULT_CONFIG)
else:
# There is a config environment variable. Try to load it.
# Do not check for existence, so invalid file paths raise an error.
logger.debug("User config not found or not specified. Loading default config.")
return get_config(env_config_file)
cookiecutter-2.6.0/cookiecutter/environment.py 0000664 0000000 0000000 00000004351 14565433335 0021653 0 ustar 00root root 0000000 0000000 """Jinja2 environment and extensions loading."""
from jinja2 import Environment, StrictUndefined
from cookiecutter.exceptions import UnknownExtension
class ExtensionLoaderMixin:
"""Mixin providing sane loading of extensions specified in a given context.
The context is being extracted from the keyword arguments before calling
the next parent class in line of the child.
"""
def __init__(self, **kwargs):
"""Initialize the Jinja2 Environment object while loading extensions.
Does the following:
1. Establishes default_extensions (currently just a Time feature)
2. Reads extensions set in the cookiecutter.json _extensions key.
3. Attempts to load the extensions. Provides useful error if fails.
"""
context = kwargs.pop('context', {})
default_extensions = [
'cookiecutter.extensions.JsonifyExtension',
'cookiecutter.extensions.RandomStringExtension',
'cookiecutter.extensions.SlugifyExtension',
'cookiecutter.extensions.TimeExtension',
'cookiecutter.extensions.UUIDExtension',
]
extensions = default_extensions + self._read_extensions(context)
try:
super().__init__(extensions=extensions, **kwargs)
except ImportError as err:
raise UnknownExtension(f'Unable to load extension: {err}') from err
def _read_extensions(self, context):
"""Return list of extensions as str to be passed on to the Jinja2 env.
If context does not contain the relevant info, return an empty
list instead.
"""
try:
extensions = context['cookiecutter']['_extensions']
except KeyError:
return []
else:
return [str(ext) for ext in extensions]
class StrictEnvironment(ExtensionLoaderMixin, Environment):
"""Create strict Jinja2 environment.
Jinja2 environment will raise error on undefined variable in template-
rendering context.
"""
def __init__(self, **kwargs):
"""Set the standard Cookiecutter StrictEnvironment.
Also loading extensions defined in cookiecutter.json's _extensions key.
"""
super().__init__(undefined=StrictUndefined, **kwargs)
cookiecutter-2.6.0/cookiecutter/exceptions.py 0000664 0000000 0000000 00000007456 14565433335 0021501 0 ustar 00root root 0000000 0000000 """All exceptions used in the Cookiecutter code base are defined here."""
class CookiecutterException(Exception):
"""
Base exception class.
All Cookiecutter-specific exceptions should subclass this class.
"""
class NonTemplatedInputDirException(CookiecutterException):
"""
Exception for when a project's input dir is not templated.
The name of the input directory should always contain a string that is
rendered to something else, so that input_dir != output_dir.
"""
class UnknownTemplateDirException(CookiecutterException):
"""
Exception for ambiguous project template directory.
Raised when Cookiecutter cannot determine which directory is the project
template, e.g. more than one dir appears to be a template dir.
"""
# unused locally
class MissingProjectDir(CookiecutterException):
"""
Exception for missing generated project directory.
Raised during cleanup when remove_repo() can't find a generated project
directory inside of a repo.
"""
# unused locally
class ConfigDoesNotExistException(CookiecutterException):
"""
Exception for missing config file.
Raised when get_config() is passed a path to a config file, but no file
is found at that path.
"""
class InvalidConfiguration(CookiecutterException):
"""
Exception for invalid configuration file.
Raised if the global configuration file is not valid YAML or is
badly constructed.
"""
class UnknownRepoType(CookiecutterException):
"""
Exception for unknown repo types.
Raised if a repo's type cannot be determined.
"""
class VCSNotInstalled(CookiecutterException):
"""
Exception when version control is unavailable.
Raised if the version control system (git or hg) is not installed.
"""
class ContextDecodingException(CookiecutterException):
"""
Exception for failed JSON decoding.
Raised when a project's JSON context file can not be decoded.
"""
class OutputDirExistsException(CookiecutterException):
"""
Exception for existing output directory.
Raised when the output directory of the project exists already.
"""
class InvalidModeException(CookiecutterException):
"""
Exception for incompatible modes.
Raised when cookiecutter is called with both `no_input==True` and
`replay==True` at the same time.
"""
class FailedHookException(CookiecutterException):
"""
Exception for hook failures.
Raised when a hook script fails.
"""
class UndefinedVariableInTemplate(CookiecutterException):
"""
Exception for out-of-scope variables.
Raised when a template uses a variable which is not defined in the
context.
"""
def __init__(self, message, error, context):
"""Exception for out-of-scope variables."""
self.message = message
self.error = error
self.context = context
def __str__(self):
"""Text representation of UndefinedVariableInTemplate."""
return (
f"{self.message}. "
f"Error message: {self.error.message}. "
f"Context: {self.context}"
)
class UnknownExtension(CookiecutterException):
"""
Exception for un-importable extension.
Raised when an environment is unable to import a required extension.
"""
class RepositoryNotFound(CookiecutterException):
"""
Exception for missing repo.
Raised when the specified cookiecutter repository doesn't exist.
"""
class RepositoryCloneFailed(CookiecutterException):
"""
Exception for un-cloneable repo.
Raised when a cookiecutter template can't be cloned.
"""
class InvalidZipRepository(CookiecutterException):
"""
Exception for bad zip repo.
Raised when the specified cookiecutter repository isn't a valid
Zip archive.
"""
cookiecutter-2.6.0/cookiecutter/extensions.py 0000664 0000000 0000000 00000007566 14565433335 0021521 0 ustar 00root root 0000000 0000000 """Jinja2 extensions."""
import json
import string
import uuid
from secrets import choice
import arrow
from jinja2 import nodes
from jinja2.ext import Extension
from slugify import slugify as pyslugify
class JsonifyExtension(Extension):
"""Jinja2 extension to convert a Python object to JSON."""
def __init__(self, environment):
"""Initialize the extension with the given environment."""
super().__init__(environment)
def jsonify(obj):
return json.dumps(obj, sort_keys=True, indent=4)
environment.filters['jsonify'] = jsonify
class RandomStringExtension(Extension):
"""Jinja2 extension to create a random string."""
def __init__(self, environment):
"""Jinja2 Extension Constructor."""
super().__init__(environment)
def random_ascii_string(length, punctuation=False):
if punctuation:
corpus = "".join((string.ascii_letters, string.punctuation))
else:
corpus = string.ascii_letters
return "".join(choice(corpus) for _ in range(length))
environment.globals.update(random_ascii_string=random_ascii_string)
class SlugifyExtension(Extension):
"""Jinja2 Extension to slugify string."""
def __init__(self, environment):
"""Jinja2 Extension constructor."""
super().__init__(environment)
def slugify(value, **kwargs):
"""Slugifies the value."""
return pyslugify(value, **kwargs)
environment.filters['slugify'] = slugify
class UUIDExtension(Extension):
"""Jinja2 Extension to generate uuid4 string."""
def __init__(self, environment):
"""Jinja2 Extension constructor."""
super().__init__(environment)
def uuid4():
"""Generate UUID4."""
return str(uuid.uuid4())
environment.globals.update(uuid4=uuid4)
class TimeExtension(Extension):
"""Jinja2 Extension for dates and times."""
tags = {'now'}
def __init__(self, environment):
"""Jinja2 Extension constructor."""
super().__init__(environment)
environment.extend(datetime_format='%Y-%m-%d')
def _datetime(self, timezone, operator, offset, datetime_format):
d = arrow.now(timezone)
# parse shift params from offset and include operator
shift_params = {}
for param in offset.split(','):
interval, value = param.split('=')
shift_params[interval.strip()] = float(operator + value.strip())
d = d.shift(**shift_params)
if datetime_format is None:
datetime_format = self.environment.datetime_format
return d.strftime(datetime_format)
def _now(self, timezone, datetime_format):
if datetime_format is None:
datetime_format = self.environment.datetime_format
return arrow.now(timezone).strftime(datetime_format)
def parse(self, parser):
"""Parse datetime template and add datetime value."""
lineno = next(parser.stream).lineno
node = parser.parse_expression()
if parser.stream.skip_if('comma'):
datetime_format = parser.parse_expression()
else:
datetime_format = nodes.Const(None)
if isinstance(node, nodes.Add):
call_method = self.call_method(
'_datetime',
[node.left, nodes.Const('+'), node.right, datetime_format],
lineno=lineno,
)
elif isinstance(node, nodes.Sub):
call_method = self.call_method(
'_datetime',
[node.left, nodes.Const('-'), node.right, datetime_format],
lineno=lineno,
)
else:
call_method = self.call_method(
'_now',
[node, datetime_format],
lineno=lineno,
)
return nodes.Output([call_method], lineno=lineno)
cookiecutter-2.6.0/cookiecutter/find.py 0000664 0000000 0000000 00000002030 14565433335 0020217 0 ustar 00root root 0000000 0000000 """Functions for finding Cookiecutter templates and other components."""
import logging
import os
from pathlib import Path
from jinja2 import Environment
from cookiecutter.exceptions import NonTemplatedInputDirException
logger = logging.getLogger(__name__)
def find_template(repo_dir: "os.PathLike[str]", env: Environment) -> Path:
"""Determine which child directory of ``repo_dir`` is the project template.
:param repo_dir: Local directory of newly cloned repo.
:return: Relative path to project template.
"""
logger.debug('Searching %s for the project template.', repo_dir)
for str_path in os.listdir(repo_dir):
if (
'cookiecutter' in str_path
and env.variable_start_string in str_path
and env.variable_end_string in str_path
):
project_template = Path(repo_dir, str_path)
break
else:
raise NonTemplatedInputDirException
logger.debug('The project template appears to be %s', project_template)
return project_template
cookiecutter-2.6.0/cookiecutter/generate.py 0000664 0000000 0000000 00000040145 14565433335 0021102 0 ustar 00root root 0000000 0000000 """Functions for generating a project from a project template."""
import fnmatch
import json
import logging
import os
import shutil
import warnings
from collections import OrderedDict
from pathlib import Path
from binaryornot.check import is_binary
from jinja2 import Environment, FileSystemLoader
from jinja2.exceptions import TemplateSyntaxError, UndefinedError
from cookiecutter.exceptions import (
ContextDecodingException,
OutputDirExistsException,
UndefinedVariableInTemplate,
)
from cookiecutter.find import find_template
from cookiecutter.hooks import run_hook_from_repo_dir
from cookiecutter.utils import (
create_env_with_context,
make_sure_path_exists,
rmtree,
work_in,
)
logger = logging.getLogger(__name__)
def is_copy_only_path(path, context):
"""Check whether the given `path` should only be copied and not rendered.
Returns True if `path` matches a pattern in the given `context` dict,
otherwise False.
:param path: A file-system path referring to a file or dir that
should be rendered or just copied.
:param context: cookiecutter context.
"""
try:
for dont_render in context['cookiecutter']['_copy_without_render']:
if fnmatch.fnmatch(path, dont_render):
return True
except KeyError:
return False
return False
def apply_overwrites_to_context(
context, overwrite_context, *, in_dictionary_variable=False
):
"""Modify the given context in place based on the overwrite_context."""
for variable, overwrite in overwrite_context.items():
if variable not in context:
if not in_dictionary_variable:
# We are dealing with a new variable on first level, ignore
continue
# We are dealing with a new dictionary variable in a deeper level
context[variable] = overwrite
context_value = context[variable]
if isinstance(context_value, list):
if in_dictionary_variable:
context[variable] = overwrite
continue
if isinstance(overwrite, list):
# We are dealing with a multichoice variable
# Let's confirm all choices are valid for the given context
if set(overwrite).issubset(set(context_value)):
context[variable] = overwrite
else:
raise ValueError(
f"{overwrite} provided for multi-choice variable "
f"{variable}, but valid choices are {context_value}"
)
else:
# We are dealing with a choice variable
if overwrite in context_value:
# This overwrite is actually valid for the given context
# Let's set it as default (by definition first item in list)
# see ``cookiecutter.prompt.prompt_choice_for_config``
context_value.remove(overwrite)
context_value.insert(0, overwrite)
else:
raise ValueError(
f"{overwrite} provided for choice variable "
f"{variable}, but the choices are {context_value}."
)
elif isinstance(context_value, dict) and isinstance(overwrite, dict):
# Partially overwrite some keys in original dict
apply_overwrites_to_context(
context_value, overwrite, in_dictionary_variable=True
)
context[variable] = context_value
else:
# Simply overwrite the value for this variable
context[variable] = overwrite
def generate_context(
context_file='cookiecutter.json', default_context=None, extra_context=None
):
"""Generate the context for a Cookiecutter project template.
Loads the JSON file as a Python object, with key being the JSON filename.
:param context_file: JSON file containing key/value pairs for populating
the cookiecutter's variables.
:param default_context: Dictionary containing config to take into account.
:param extra_context: Dictionary containing configuration overrides
"""
context = OrderedDict([])
try:
with open(context_file, encoding='utf-8') as file_handle:
obj = json.load(file_handle, object_pairs_hook=OrderedDict)
except ValueError as e:
# JSON decoding error. Let's throw a new exception that is more
# friendly for the developer or user.
full_fpath = os.path.abspath(context_file)
json_exc_message = str(e)
our_exc_message = (
f"JSON decoding error while loading '{full_fpath}'. "
f"Decoding error details: '{json_exc_message}'"
)
raise ContextDecodingException(our_exc_message) from e
# Add the Python object to the context dictionary
file_name = os.path.split(context_file)[1]
file_stem = file_name.split('.')[0]
context[file_stem] = obj
# Overwrite context variable defaults with the default context from the
# user's global config, if available
if default_context:
try:
apply_overwrites_to_context(obj, default_context)
except ValueError as error:
warnings.warn(f"Invalid default received: {error}")
if extra_context:
apply_overwrites_to_context(obj, extra_context)
logger.debug('Context generated is %s', context)
return context
def generate_file(project_dir, infile, context, env, skip_if_file_exists=False):
"""Render filename of infile as name of outfile, handle infile correctly.
Dealing with infile appropriately:
a. If infile is a binary file, copy it over without rendering.
b. If infile is a text file, render its contents and write the
rendered infile to outfile.
Precondition:
When calling `generate_file()`, the root template dir must be the
current working directory. Using `utils.work_in()` is the recommended
way to perform this directory change.
:param project_dir: Absolute path to the resulting generated project.
:param infile: Input file to generate the file from. Relative to the root
template dir.
:param context: Dict for populating the cookiecutter's variables.
:param env: Jinja2 template execution environment.
"""
logger.debug('Processing file %s', infile)
# Render the path to the output file (not including the root project dir)
outfile_tmpl = env.from_string(infile)
outfile = os.path.join(project_dir, outfile_tmpl.render(**context))
file_name_is_empty = os.path.isdir(outfile)
if file_name_is_empty:
logger.debug('The resulting file name is empty: %s', outfile)
return
if skip_if_file_exists and os.path.exists(outfile):
logger.debug('The resulting file already exists: %s', outfile)
return
logger.debug('Created file at %s', outfile)
# Just copy over binary files. Don't render.
logger.debug("Check %s to see if it's a binary", infile)
if is_binary(infile):
logger.debug('Copying binary %s to %s without rendering', infile, outfile)
shutil.copyfile(infile, outfile)
shutil.copymode(infile, outfile)
return
# Force fwd slashes on Windows for get_template
# This is a by-design Jinja issue
infile_fwd_slashes = infile.replace(os.path.sep, '/')
# Render the file
try:
tmpl = env.get_template(infile_fwd_slashes)
except TemplateSyntaxError as exception:
# Disable translated so that printed exception contains verbose
# information about syntax error location
exception.translated = False
raise
rendered_file = tmpl.render(**context)
if context['cookiecutter'].get('_new_lines', False):
# Use `_new_lines` from context, if configured.
newline = context['cookiecutter']['_new_lines']
logger.debug('Using configured newline character %s', repr(newline))
else:
# Detect original file newline to output the rendered file.
# Note that newlines can be a tuple if file contains mixed line endings.
# In this case, we pick the first line ending we detected.
with open(infile, encoding='utf-8') as rd:
rd.readline() # Read only the first line to load a 'newlines' value.
newline = rd.newlines[0] if isinstance(rd.newlines, tuple) else rd.newlines
logger.debug('Using detected newline character %s', repr(newline))
logger.debug('Writing contents to file %s', outfile)
with open(outfile, 'w', encoding='utf-8', newline=newline) as fh:
fh.write(rendered_file)
# Apply file permissions to output file
shutil.copymode(infile, outfile)
def render_and_create_dir(
dirname: str,
context: dict,
output_dir: "os.PathLike[str]",
environment: Environment,
overwrite_if_exists: bool = False,
):
"""Render name of a directory, create the directory, return its path."""
name_tmpl = environment.from_string(dirname)
rendered_dirname = name_tmpl.render(**context)
dir_to_create = Path(output_dir, rendered_dirname)
logger.debug(
'Rendered dir %s must exist in output_dir %s', dir_to_create, output_dir
)
output_dir_exists = dir_to_create.exists()
if output_dir_exists:
if overwrite_if_exists:
logger.debug(
'Output directory %s already exists, overwriting it', dir_to_create
)
else:
msg = f'Error: "{dir_to_create}" directory already exists'
raise OutputDirExistsException(msg)
else:
make_sure_path_exists(dir_to_create)
return dir_to_create, not output_dir_exists
def _run_hook_from_repo_dir(
repo_dir, hook_name, project_dir, context, delete_project_on_failure
):
"""Run hook from repo directory, clean project directory if hook fails.
:param repo_dir: Project template input directory.
:param hook_name: The hook to execute.
:param project_dir: The directory to execute the script from.
:param context: Cookiecutter project context.
:param delete_project_on_failure: Delete the project directory on hook
failure?
"""
warnings.warn(
"The '_run_hook_from_repo_dir' function is deprecated, "
"use 'cookiecutter.hooks.run_hook_from_repo_dir' instead",
DeprecationWarning,
2,
)
run_hook_from_repo_dir(
repo_dir, hook_name, project_dir, context, delete_project_on_failure
)
def generate_files(
repo_dir,
context=None,
output_dir='.',
overwrite_if_exists=False,
skip_if_file_exists=False,
accept_hooks=True,
keep_project_on_failure=False,
):
"""Render the templates and saves them to files.
:param repo_dir: Project template input directory.
:param context: Dict for populating the template's variables.
:param output_dir: Where to output the generated project dir into.
:param overwrite_if_exists: Overwrite the contents of the output directory
if it exists.
:param skip_if_file_exists: Skip the files in the corresponding directories
if they already exist
:param accept_hooks: Accept pre and post hooks if set to `True`.
:param keep_project_on_failure: If `True` keep generated project directory even when
generation fails
"""
context = context or OrderedDict([])
env = create_env_with_context(context)
template_dir = find_template(repo_dir, env)
logger.debug('Generating project from %s...', template_dir)
unrendered_dir = os.path.split(template_dir)[1]
try:
project_dir, output_directory_created = render_and_create_dir(
unrendered_dir, context, output_dir, env, overwrite_if_exists
)
except UndefinedError as err:
msg = f"Unable to create project directory '{unrendered_dir}'"
raise UndefinedVariableInTemplate(msg, err, context) from err
# We want the Jinja path and the OS paths to match. Consequently, we'll:
# + CD to the template folder
# + Set Jinja's path to '.'
#
# In order to build our files to the correct folder(s), we'll use an
# absolute path for the target folder (project_dir)
project_dir = os.path.abspath(project_dir)
logger.debug('Project directory is %s', project_dir)
# if we created the output directory, then it's ok to remove it
# if rendering fails
delete_project_on_failure = output_directory_created and not keep_project_on_failure
if accept_hooks:
run_hook_from_repo_dir(
repo_dir, 'pre_gen_project', project_dir, context, delete_project_on_failure
)
with work_in(template_dir):
env.loader = FileSystemLoader(['.', '../templates'])
for root, dirs, files in os.walk('.'):
# We must separate the two types of dirs into different lists.
# The reason is that we don't want ``os.walk`` to go through the
# unrendered directories, since they will just be copied.
copy_dirs = []
render_dirs = []
for d in dirs:
d_ = os.path.normpath(os.path.join(root, d))
# We check the full path, because that's how it can be
# specified in the ``_copy_without_render`` setting, but
# we store just the dir name
if is_copy_only_path(d_, context):
logger.debug('Found copy only path %s', d)
copy_dirs.append(d)
else:
render_dirs.append(d)
for copy_dir in copy_dirs:
indir = os.path.normpath(os.path.join(root, copy_dir))
outdir = os.path.normpath(os.path.join(project_dir, indir))
outdir = env.from_string(outdir).render(**context)
logger.debug('Copying dir %s to %s without rendering', indir, outdir)
# The outdir is not the root dir, it is the dir which marked as copy
# only in the config file. If the program hits this line, which means
# the overwrite_if_exists = True, and root dir exists
if os.path.isdir(outdir):
shutil.rmtree(outdir)
shutil.copytree(indir, outdir)
# We mutate ``dirs``, because we only want to go through these dirs
# recursively
dirs[:] = render_dirs
for d in dirs:
unrendered_dir = os.path.join(project_dir, root, d)
try:
render_and_create_dir(
unrendered_dir, context, output_dir, env, overwrite_if_exists
)
except UndefinedError as err:
if delete_project_on_failure:
rmtree(project_dir)
_dir = os.path.relpath(unrendered_dir, output_dir)
msg = f"Unable to create directory '{_dir}'"
raise UndefinedVariableInTemplate(msg, err, context) from err
for f in files:
infile = os.path.normpath(os.path.join(root, f))
if is_copy_only_path(infile, context):
outfile_tmpl = env.from_string(infile)
outfile_rendered = outfile_tmpl.render(**context)
outfile = os.path.join(project_dir, outfile_rendered)
logger.debug(
'Copying file %s to %s without rendering', infile, outfile
)
shutil.copyfile(infile, outfile)
shutil.copymode(infile, outfile)
continue
try:
generate_file(
project_dir, infile, context, env, skip_if_file_exists
)
except UndefinedError as err:
if delete_project_on_failure:
rmtree(project_dir)
msg = f"Unable to create file '{infile}'"
raise UndefinedVariableInTemplate(msg, err, context) from err
if accept_hooks:
run_hook_from_repo_dir(
repo_dir,
'post_gen_project',
project_dir,
context,
delete_project_on_failure,
)
return project_dir
cookiecutter-2.6.0/cookiecutter/hooks.py 0000664 0000000 0000000 00000013611 14565433335 0020431 0 ustar 00root root 0000000 0000000 """Functions for discovering and executing various cookiecutter hooks."""
import errno
import logging
import os
import subprocess # nosec
import sys
import tempfile
from pathlib import Path
from jinja2.exceptions import UndefinedError
from cookiecutter import utils
from cookiecutter.exceptions import FailedHookException
from cookiecutter.utils import (
create_env_with_context,
create_tmp_repo_dir,
rmtree,
work_in,
)
logger = logging.getLogger(__name__)
_HOOKS = [
'pre_prompt',
'pre_gen_project',
'post_gen_project',
]
EXIT_SUCCESS = 0
def valid_hook(hook_file, hook_name):
"""Determine if a hook file is valid.
:param hook_file: The hook file to consider for validity
:param hook_name: The hook to find
:return: The hook file validity
"""
filename = os.path.basename(hook_file)
basename = os.path.splitext(filename)[0]
matching_hook = basename == hook_name
supported_hook = basename in _HOOKS
backup_file = filename.endswith('~')
return matching_hook and supported_hook and not backup_file
def find_hook(hook_name, hooks_dir='hooks'):
"""Return a dict of all hook scripts provided.
Must be called with the project template as the current working directory.
Dict's key will be the hook/script's name, without extension, while values
will be the absolute path to the script. Missing scripts will not be
included in the returned dict.
:param hook_name: The hook to find
:param hooks_dir: The hook directory in the template
:return: The absolute path to the hook script or None
"""
logger.debug('hooks_dir is %s', os.path.abspath(hooks_dir))
if not os.path.isdir(hooks_dir):
logger.debug('No hooks/dir in template_dir')
return None
scripts = []
for hook_file in os.listdir(hooks_dir):
if valid_hook(hook_file, hook_name):
scripts.append(os.path.abspath(os.path.join(hooks_dir, hook_file)))
if len(scripts) == 0:
return None
return scripts
def run_script(script_path, cwd='.'):
"""Execute a script from a working directory.
:param script_path: Absolute path to the script to run.
:param cwd: The directory to run the script from.
"""
run_thru_shell = sys.platform.startswith('win')
if script_path.endswith('.py'):
script_command = [sys.executable, script_path]
else:
script_command = [script_path]
utils.make_executable(script_path)
try:
proc = subprocess.Popen(script_command, shell=run_thru_shell, cwd=cwd) # nosec
exit_status = proc.wait()
if exit_status != EXIT_SUCCESS:
raise FailedHookException(
f'Hook script failed (exit status: {exit_status})'
)
except OSError as err:
if err.errno == errno.ENOEXEC:
raise FailedHookException(
'Hook script failed, might be an empty file or missing a shebang'
) from err
raise FailedHookException(f'Hook script failed (error: {err})') from err
def run_script_with_context(script_path, cwd, context):
"""Execute a script after rendering it with Jinja.
:param script_path: Absolute path to the script to run.
:param cwd: The directory to run the script from.
:param context: Cookiecutter project template context.
"""
_, extension = os.path.splitext(script_path)
with open(script_path, encoding='utf-8') as file:
contents = file.read()
with tempfile.NamedTemporaryFile(delete=False, mode='wb', suffix=extension) as temp:
env = create_env_with_context(context)
template = env.from_string(contents)
output = template.render(**context)
temp.write(output.encode('utf-8'))
run_script(temp.name, cwd)
def run_hook(hook_name, project_dir, context):
"""
Try to find and execute a hook from the specified project directory.
:param hook_name: The hook to execute.
:param project_dir: The directory to execute the script from.
:param context: Cookiecutter project context.
"""
scripts = find_hook(hook_name)
if not scripts:
logger.debug('No %s hook found', hook_name)
return
logger.debug('Running hook %s', hook_name)
for script in scripts:
run_script_with_context(script, project_dir, context)
def run_hook_from_repo_dir(
repo_dir, hook_name, project_dir, context, delete_project_on_failure
):
"""Run hook from repo directory, clean project directory if hook fails.
:param repo_dir: Project template input directory.
:param hook_name: The hook to execute.
:param project_dir: The directory to execute the script from.
:param context: Cookiecutter project context.
:param delete_project_on_failure: Delete the project directory on hook
failure?
"""
with work_in(repo_dir):
try:
run_hook(hook_name, project_dir, context)
except (
FailedHookException,
UndefinedError,
):
if delete_project_on_failure:
rmtree(project_dir)
logger.error(
"Stopping generation because %s hook "
"script didn't exit successfully",
hook_name,
)
raise
def run_pre_prompt_hook(repo_dir: "os.PathLike[str]") -> Path:
"""Run pre_prompt hook from repo directory.
:param repo_dir: Project template input directory.
"""
# Check if we have a valid pre_prompt script
with work_in(repo_dir):
scripts = find_hook('pre_prompt')
if not scripts:
return repo_dir
# Create a temporary directory
repo_dir = create_tmp_repo_dir(repo_dir)
with work_in(repo_dir):
scripts = find_hook('pre_prompt')
for script in scripts:
try:
run_script(script, repo_dir)
except FailedHookException:
raise FailedHookException('Pre-Prompt Hook script failed')
return repo_dir
cookiecutter-2.6.0/cookiecutter/log.py 0000664 0000000 0000000 00000003041 14565433335 0020063 0 ustar 00root root 0000000 0000000 """Module for setting up logging."""
import logging
import sys
LOG_LEVELS = {
'DEBUG': logging.DEBUG,
'INFO': logging.INFO,
'WARNING': logging.WARNING,
'ERROR': logging.ERROR,
'CRITICAL': logging.CRITICAL,
}
LOG_FORMATS = {
'DEBUG': '%(levelname)s %(name)s: %(message)s',
'INFO': '%(levelname)s: %(message)s',
}
def configure_logger(stream_level='DEBUG', debug_file=None):
"""Configure logging for cookiecutter.
Set up logging to stdout with given level. If ``debug_file`` is given set
up logging to file with DEBUG level.
"""
# Set up 'cookiecutter' logger
logger = logging.getLogger('cookiecutter')
logger.setLevel(logging.DEBUG)
# Remove all attached handlers, in case there was
# a logger with using the name 'cookiecutter'
del logger.handlers[:]
# Create a file handler if a log file is provided
if debug_file is not None:
debug_formatter = logging.Formatter(LOG_FORMATS['DEBUG'])
file_handler = logging.FileHandler(debug_file)
file_handler.setLevel(LOG_LEVELS['DEBUG'])
file_handler.setFormatter(debug_formatter)
logger.addHandler(file_handler)
# Get settings based on the given stream_level
log_formatter = logging.Formatter(LOG_FORMATS[stream_level])
log_level = LOG_LEVELS[stream_level]
# Create a stream handler
stream_handler = logging.StreamHandler(stream=sys.stdout)
stream_handler.setLevel(log_level)
stream_handler.setFormatter(log_formatter)
logger.addHandler(stream_handler)
return logger
cookiecutter-2.6.0/cookiecutter/main.py 0000664 0000000 0000000 00000017200 14565433335 0020230 0 ustar 00root root 0000000 0000000 """
Main entry point for the `cookiecutter` command.
The code in this module is also a good example of how to use Cookiecutter as a
library rather than a script.
"""
import logging
import os
import sys
from copy import copy
from pathlib import Path
from cookiecutter.config import get_user_config
from cookiecutter.exceptions import InvalidModeException
from cookiecutter.generate import generate_context, generate_files
from cookiecutter.hooks import run_pre_prompt_hook
from cookiecutter.prompt import choose_nested_template, prompt_for_config
from cookiecutter.replay import dump, load
from cookiecutter.repository import determine_repo_dir
from cookiecutter.utils import rmtree
logger = logging.getLogger(__name__)
def cookiecutter(
template,
checkout=None,
no_input=False,
extra_context=None,
replay=None,
overwrite_if_exists=False,
output_dir='.',
config_file=None,
default_config=False,
password=None,
directory=None,
skip_if_file_exists=False,
accept_hooks=True,
keep_project_on_failure=False,
):
"""
Run Cookiecutter just as if using it from the command line.
:param template: A directory containing a project template directory,
or a URL to a git repository.
:param checkout: The branch, tag or commit ID to checkout after clone.
:param no_input: Do not prompt for user input.
Use default values for template parameters taken from `cookiecutter.json`, user
config and `extra_dict`. Force a refresh of cached resources.
:param extra_context: A dictionary of context that overrides default
and user configuration.
:param replay: Do not prompt for input, instead read from saved json. If
``True`` read from the ``replay_dir``.
if it exists
:param overwrite_if_exists: Overwrite the contents of the output directory
if it exists.
:param output_dir: Where to output the generated project dir into.
:param config_file: User configuration file path.
:param default_config: Use default values rather than a config file.
:param password: The password to use when extracting the repository.
:param directory: Relative path to a cookiecutter template in a repository.
:param skip_if_file_exists: Skip the files in the corresponding directories
if they already exist.
:param accept_hooks: Accept pre and post hooks if set to `True`.
:param keep_project_on_failure: If `True` keep generated project directory even when
generation fails
"""
if replay and ((no_input is not False) or (extra_context is not None)):
err_msg = (
"You can not use both replay and no_input or extra_context "
"at the same time."
)
raise InvalidModeException(err_msg)
config_dict = get_user_config(
config_file=config_file,
default_config=default_config,
)
base_repo_dir, cleanup_base_repo_dir = determine_repo_dir(
template=template,
abbreviations=config_dict['abbreviations'],
clone_to_dir=config_dict['cookiecutters_dir'],
checkout=checkout,
no_input=no_input,
password=password,
directory=directory,
)
repo_dir, cleanup = base_repo_dir, cleanup_base_repo_dir
# Run pre_prompt hook
repo_dir = run_pre_prompt_hook(base_repo_dir) if accept_hooks else repo_dir
# Always remove temporary dir if it was created
cleanup = True if repo_dir != base_repo_dir else False
import_patch = _patch_import_path_for_repo(repo_dir)
template_name = os.path.basename(os.path.abspath(repo_dir))
if replay:
with import_patch:
if isinstance(replay, bool):
context_from_replayfile = load(config_dict['replay_dir'], template_name)
else:
path, template_name = os.path.split(os.path.splitext(replay)[0])
context_from_replayfile = load(path, template_name)
context_file = os.path.join(repo_dir, 'cookiecutter.json')
logger.debug('context_file is %s', context_file)
if replay:
context = generate_context(
context_file=context_file,
default_context=config_dict['default_context'],
extra_context=None,
)
logger.debug('replayfile context: %s', context_from_replayfile)
items_for_prompting = {
k: v
for k, v in context['cookiecutter'].items()
if k not in context_from_replayfile['cookiecutter'].keys()
}
context_for_prompting = {}
context_for_prompting['cookiecutter'] = items_for_prompting
context = context_from_replayfile
logger.debug('prompting context: %s', context_for_prompting)
else:
context = generate_context(
context_file=context_file,
default_context=config_dict['default_context'],
extra_context=extra_context,
)
context_for_prompting = context
# preserve the original cookiecutter options
# print(context['cookiecutter'])
context['_cookiecutter'] = {
k: v for k, v in context['cookiecutter'].items() if not k.startswith("_")
}
# prompt the user to manually configure at the command line.
# except when 'no-input' flag is set
with import_patch:
if {"template", "templates"} & set(context["cookiecutter"].keys()):
nested_template = choose_nested_template(context, repo_dir, no_input)
return cookiecutter(
template=nested_template,
checkout=checkout,
no_input=no_input,
extra_context=extra_context,
replay=replay,
overwrite_if_exists=overwrite_if_exists,
output_dir=output_dir,
config_file=config_file,
default_config=default_config,
password=password,
directory=directory,
skip_if_file_exists=skip_if_file_exists,
accept_hooks=accept_hooks,
keep_project_on_failure=keep_project_on_failure,
)
if context_for_prompting['cookiecutter']:
context['cookiecutter'].update(
prompt_for_config(context_for_prompting, no_input)
)
logger.debug('context is %s', context)
# include template dir or url in the context dict
context['cookiecutter']['_template'] = template
# include output+dir in the context dict
context['cookiecutter']['_output_dir'] = os.path.abspath(output_dir)
# include repo dir or url in the context dict
context['cookiecutter']['_repo_dir'] = f"{repo_dir}"
# include checkout details in the context dict
context['cookiecutter']['_checkout'] = checkout
dump(config_dict['replay_dir'], template_name, context)
# Create project from local context and project template.
with import_patch:
result = generate_files(
repo_dir=repo_dir,
context=context,
overwrite_if_exists=overwrite_if_exists,
skip_if_file_exists=skip_if_file_exists,
output_dir=output_dir,
accept_hooks=accept_hooks,
keep_project_on_failure=keep_project_on_failure,
)
# Cleanup (if required)
if cleanup:
rmtree(repo_dir)
if cleanup_base_repo_dir:
rmtree(base_repo_dir)
return result
class _patch_import_path_for_repo:
def __init__(self, repo_dir: "os.PathLike[str]"):
self._repo_dir = f"{repo_dir}" if isinstance(repo_dir, Path) else repo_dir
self._path = None
def __enter__(self):
self._path = copy(sys.path)
sys.path.append(self._repo_dir)
def __exit__(self, type, value, traceback):
sys.path = self._path
cookiecutter-2.6.0/cookiecutter/prompt.py 0000664 0000000 0000000 00000033543 14565433335 0020635 0 ustar 00root root 0000000 0000000 """Functions for prompting the user for project info."""
import json
import os
import re
import sys
from collections import OrderedDict
from pathlib import Path
from jinja2.exceptions import UndefinedError
from rich.prompt import Confirm, InvalidResponse, Prompt, PromptBase
from cookiecutter.exceptions import UndefinedVariableInTemplate
from cookiecutter.utils import create_env_with_context, rmtree
def read_user_variable(var_name, default_value, prompts=None, prefix=""):
"""Prompt user for variable and return the entered value or given default.
:param str var_name: Variable of the context to query the user
:param default_value: Value that will be returned if no input happens
"""
question = (
prompts[var_name]
if prompts and var_name in prompts.keys() and prompts[var_name]
else var_name
)
while True:
variable = Prompt.ask(f"{prefix}{question}", default=default_value)
if variable is not None:
break
return variable
class YesNoPrompt(Confirm):
"""A prompt that returns a boolean for yes/no questions."""
yes_choices = ["1", "true", "t", "yes", "y", "on"]
no_choices = ["0", "false", "f", "no", "n", "off"]
def process_response(self, value: str) -> bool:
"""Convert choices to a bool."""
value = value.strip().lower()
if value in self.yes_choices:
return True
elif value in self.no_choices:
return False
else:
raise InvalidResponse(self.validate_error_message)
def read_user_yes_no(var_name, default_value, prompts=None, prefix=""):
"""Prompt the user to reply with 'yes' or 'no' (or equivalent values).
- These input values will be converted to ``True``:
"1", "true", "t", "yes", "y", "on"
- These input values will be converted to ``False``:
"0", "false", "f", "no", "n", "off"
Actual parsing done by :func:`prompt`; Check this function codebase change in
case of unexpected behaviour.
:param str question: Question to the user
:param default_value: Value that will be returned if no input happens
"""
question = (
prompts[var_name]
if prompts and var_name in prompts.keys() and prompts[var_name]
else var_name
)
return YesNoPrompt.ask(f"{prefix}{question}", default=default_value)
def read_repo_password(question):
"""Prompt the user to enter a password.
:param str question: Question to the user
"""
return Prompt.ask(question, password=True)
def read_user_choice(var_name, options, prompts=None, prefix=""):
"""Prompt the user to choose from several options for the given variable.
The first item will be returned if no input happens.
:param str var_name: Variable as specified in the context
:param list options: Sequence of options that are available to select from
:return: Exactly one item of ``options`` that has been chosen by the user
"""
if not isinstance(options, list):
raise TypeError
if not options:
raise ValueError
choice_map = OrderedDict((f'{i}', value) for i, value in enumerate(options, 1))
choices = choice_map.keys()
question = f"Select {var_name}"
choice_lines = [
' [bold magenta]{}[/] - [bold]{}[/]'.format(*c) for c in choice_map.items()
]
# Handle if human-readable prompt is provided
if prompts and var_name in prompts.keys():
if isinstance(prompts[var_name], str):
question = prompts[var_name]
else:
if "__prompt__" in prompts[var_name]:
question = prompts[var_name]["__prompt__"]
choice_lines = [
(
f" [bold magenta]{i}[/] - [bold]{prompts[var_name][p]}[/]"
if p in prompts[var_name]
else f" [bold magenta]{i}[/] - [bold]{p}[/]"
)
for i, p in choice_map.items()
]
prompt = '\n'.join(
(
f"{prefix}{question}",
"\n".join(choice_lines),
" Choose from",
)
)
user_choice = Prompt.ask(prompt, choices=list(choices), default=list(choices)[0])
return choice_map[user_choice]
DEFAULT_DISPLAY = 'default'
def process_json(user_value, default_value=None):
"""Load user-supplied value as a JSON dict.
:param str user_value: User-supplied value to load as a JSON dict
"""
try:
user_dict = json.loads(user_value, object_pairs_hook=OrderedDict)
except Exception as error:
# Leave it up to click to ask the user again
raise InvalidResponse('Unable to decode to JSON.') from error
if not isinstance(user_dict, dict):
# Leave it up to click to ask the user again
raise InvalidResponse('Requires JSON dict.')
return user_dict
class JsonPrompt(PromptBase[dict]):
"""A prompt that returns a dict from JSON string."""
default = None
response_type = dict
validate_error_message = "[prompt.invalid] Please enter a valid JSON string"
def process_response(self, value: str) -> dict:
"""Convert choices to a dict."""
return process_json(value, self.default)
def read_user_dict(var_name, default_value, prompts=None, prefix=""):
"""Prompt the user to provide a dictionary of data.
:param str var_name: Variable as specified in the context
:param default_value: Value that will be returned if no input is provided
:return: A Python dictionary to use in the context.
"""
if not isinstance(default_value, dict):
raise TypeError
question = (
prompts[var_name]
if prompts and var_name in prompts.keys() and prompts[var_name]
else var_name
)
user_value = JsonPrompt.ask(
f"{prefix}{question} [cyan bold]({DEFAULT_DISPLAY})[/]",
default=default_value,
show_default=False,
)
return user_value
def render_variable(env, raw, cookiecutter_dict):
"""Render the next variable to be displayed in the user prompt.
Inside the prompting taken from the cookiecutter.json file, this renders
the next variable. For example, if a project_name is "Peanut Butter
Cookie", the repo_name could be be rendered with:
`{{ cookiecutter.project_name.replace(" ", "_") }}`.
This is then presented to the user as the default.
:param Environment env: A Jinja2 Environment object.
:param raw: The next value to be prompted for by the user.
:param dict cookiecutter_dict: The current context as it's gradually
being populated with variables.
:return: The rendered value for the default variable.
"""
if raw is None or isinstance(raw, bool):
return raw
elif isinstance(raw, dict):
return {
render_variable(env, k, cookiecutter_dict): render_variable(
env, v, cookiecutter_dict
)
for k, v in raw.items()
}
elif isinstance(raw, list):
return [render_variable(env, v, cookiecutter_dict) for v in raw]
elif not isinstance(raw, str):
raw = str(raw)
template = env.from_string(raw)
return template.render(cookiecutter=cookiecutter_dict)
def _prompts_from_options(options: dict) -> dict:
"""Process template options and return friendly prompt information."""
prompts = {"__prompt__": "Select a template"}
for option_key, option_value in options.items():
title = str(option_value.get("title", option_key))
description = option_value.get("description", option_key)
label = title if title == description else f"{title} ({description})"
prompts[option_key] = label
return prompts
def prompt_choice_for_template(key, options, no_input):
"""Prompt user with a set of options to choose from.
:param no_input: Do not prompt for user input and return the first available option.
"""
opts = list(options.keys())
prompts = {"templates": _prompts_from_options(options)}
return opts[0] if no_input else read_user_choice(key, opts, prompts, "")
def prompt_choice_for_config(
cookiecutter_dict, env, key, options, no_input, prompts=None, prefix=""
):
"""Prompt user with a set of options to choose from.
:param no_input: Do not prompt for user input and return the first available option.
"""
rendered_options = [render_variable(env, raw, cookiecutter_dict) for raw in options]
if no_input:
return rendered_options[0]
return read_user_choice(key, rendered_options, prompts, prefix)
def prompt_for_config(context, no_input=False):
"""Prompt user to enter a new config.
:param dict context: Source for field names and sample values.
:param no_input: Do not prompt for user input and use only values from context.
"""
cookiecutter_dict = OrderedDict([])
env = create_env_with_context(context)
prompts = context['cookiecutter'].pop('__prompts__', {})
# First pass: Handle simple and raw variables, plus choices.
# These must be done first because the dictionaries keys and
# values might refer to them.
count = 0
all_prompts = context['cookiecutter'].items()
visible_prompts = [k for k, _ in all_prompts if not k.startswith("_")]
size = len(visible_prompts)
for key, raw in all_prompts:
if key.startswith('_') and not key.startswith('__'):
cookiecutter_dict[key] = raw
continue
elif key.startswith('__'):
cookiecutter_dict[key] = render_variable(env, raw, cookiecutter_dict)
continue
if not isinstance(raw, dict):
count += 1
prefix = f" [dim][{count}/{size}][/] "
try:
if isinstance(raw, list):
# We are dealing with a choice variable
val = prompt_choice_for_config(
cookiecutter_dict, env, key, raw, no_input, prompts, prefix
)
cookiecutter_dict[key] = val
elif isinstance(raw, bool):
# We are dealing with a boolean variable
if no_input:
cookiecutter_dict[key] = render_variable(
env, raw, cookiecutter_dict
)
else:
cookiecutter_dict[key] = read_user_yes_no(key, raw, prompts, prefix)
elif not isinstance(raw, dict):
# We are dealing with a regular variable
val = render_variable(env, raw, cookiecutter_dict)
if not no_input:
val = read_user_variable(key, val, prompts, prefix)
cookiecutter_dict[key] = val
except UndefinedError as err:
msg = f"Unable to render variable '{key}'"
raise UndefinedVariableInTemplate(msg, err, context) from err
# Second pass; handle the dictionaries.
for key, raw in context['cookiecutter'].items():
# Skip private type dicts not to be rendered.
if key.startswith('_') and not key.startswith('__'):
continue
try:
if isinstance(raw, dict):
# We are dealing with a dict variable
count += 1
prefix = f" [dim][{count}/{size}][/] "
val = render_variable(env, raw, cookiecutter_dict)
if not no_input and not key.startswith('__'):
val = read_user_dict(key, val, prompts, prefix)
cookiecutter_dict[key] = val
except UndefinedError as err:
msg = f"Unable to render variable '{key}'"
raise UndefinedVariableInTemplate(msg, err, context) from err
return cookiecutter_dict
def choose_nested_template(context: dict, repo_dir: str, no_input: bool = False) -> str:
"""Prompt user to select the nested template to use.
:param context: Source for field names and sample values.
:param repo_dir: Repository directory.
:param no_input: Do not prompt for user input and use only values from context.
:returns: Path to the selected template.
"""
cookiecutter_dict = OrderedDict([])
env = create_env_with_context(context)
prefix = ""
prompts = context['cookiecutter'].pop('__prompts__', {})
key = "templates"
config = context['cookiecutter'].get(key, {})
if config:
# Pass
val = prompt_choice_for_template(key, config, no_input)
template = config[val]["path"]
else:
# Old style
key = "template"
config = context['cookiecutter'].get(key, [])
val = prompt_choice_for_config(
cookiecutter_dict, env, key, config, no_input, prompts, prefix
)
template = re.search(r'\((.+)\)', val).group(1)
template = Path(template) if template else None
if not (template and not template.is_absolute()):
raise ValueError("Illegal template path")
repo_dir = Path(repo_dir).resolve()
template_path = (repo_dir / template).resolve()
# Return path as string
return f"{template_path}"
def prompt_and_delete(path, no_input=False):
"""
Ask user if it's okay to delete the previously-downloaded file/directory.
If yes, delete it. If no, checks to see if the old version should be
reused. If yes, it's reused; otherwise, Cookiecutter exits.
:param path: Previously downloaded zipfile.
:param no_input: Suppress prompt to delete repo and just delete it.
:return: True if the content was deleted
"""
# Suppress prompt if called via API
if no_input:
ok_to_delete = True
else:
question = (
f"You've downloaded {path} before. Is it okay to delete and re-download it?"
)
ok_to_delete = read_user_yes_no(question, 'yes')
if ok_to_delete:
if os.path.isdir(path):
rmtree(path)
else:
os.remove(path)
return True
else:
ok_to_reuse = read_user_yes_no(
"Do you want to re-use the existing version?", 'yes'
)
if ok_to_reuse:
return False
sys.exit()
cookiecutter-2.6.0/cookiecutter/replay.py 0000664 0000000 0000000 00000002736 14565433335 0020610 0 ustar 00root root 0000000 0000000 """
cookiecutter.replay.
-------------------
"""
import json
import os
from cookiecutter.utils import make_sure_path_exists
def get_file_name(replay_dir, template_name):
"""Get the name of file."""
suffix = '.json' if not template_name.endswith('.json') else ''
file_name = f'{template_name}{suffix}'
return os.path.join(replay_dir, file_name)
def dump(replay_dir: "os.PathLike[str]", template_name: str, context: dict):
"""Write json data to file."""
make_sure_path_exists(replay_dir)
if not isinstance(template_name, str):
raise TypeError('Template name is required to be of type str')
if not isinstance(context, dict):
raise TypeError('Context is required to be of type dict')
if 'cookiecutter' not in context:
raise ValueError('Context is required to contain a cookiecutter key')
replay_file = get_file_name(replay_dir, template_name)
with open(replay_file, 'w', encoding="utf-8") as outfile:
json.dump(context, outfile, indent=2)
def load(replay_dir, template_name):
"""Read json data from file."""
if not isinstance(template_name, str):
raise TypeError('Template name is required to be of type str')
replay_file = get_file_name(replay_dir, template_name)
with open(replay_file, encoding="utf-8") as infile:
context = json.load(infile)
if 'cookiecutter' not in context:
raise ValueError('Context is required to contain a cookiecutter key')
return context
cookiecutter-2.6.0/cookiecutter/repository.py 0000664 0000000 0000000 00000010216 14565433335 0021523 0 ustar 00root root 0000000 0000000 """Cookiecutter repository functions."""
import os
import re
from cookiecutter.exceptions import RepositoryNotFound
from cookiecutter.vcs import clone
from cookiecutter.zipfile import unzip
REPO_REGEX = re.compile(
r"""
# something like git:// ssh:// file:// etc.
((((git|hg)\+)?(git|ssh|file|https?):(//)?)
| # or
(\w+@[\w\.]+) # something like user@...
)
""",
re.VERBOSE,
)
def is_repo_url(value):
"""Return True if value is a repository URL."""
return bool(REPO_REGEX.match(value))
def is_zip_file(value):
"""Return True if value is a zip file."""
return value.lower().endswith('.zip')
def expand_abbreviations(template, abbreviations):
"""Expand abbreviations in a template name.
:param template: The project template name.
:param abbreviations: Abbreviation definitions.
"""
if template in abbreviations:
return abbreviations[template]
# Split on colon. If there is no colon, rest will be empty
# and prefix will be the whole template
prefix, sep, rest = template.partition(':')
if prefix in abbreviations:
return abbreviations[prefix].format(rest)
return template
def repository_has_cookiecutter_json(repo_directory):
"""Determine if `repo_directory` contains a `cookiecutter.json` file.
:param repo_directory: The candidate repository directory.
:return: True if the `repo_directory` is valid, else False.
"""
repo_directory_exists = os.path.isdir(repo_directory)
repo_config_exists = os.path.isfile(
os.path.join(repo_directory, 'cookiecutter.json')
)
return repo_directory_exists and repo_config_exists
def determine_repo_dir(
template,
abbreviations,
clone_to_dir,
checkout,
no_input,
password=None,
directory=None,
):
"""
Locate the repository directory from a template reference.
Applies repository abbreviations to the template reference.
If the template refers to a repository URL, clone it.
If the template is a path to a local repository, use it.
:param template: A directory containing a project template directory,
or a URL to a git repository.
:param abbreviations: A dictionary of repository abbreviation
definitions.
:param clone_to_dir: The directory to clone the repository into.
:param checkout: The branch, tag or commit ID to checkout after clone.
:param no_input: Do not prompt for user input and eventually force a refresh of
cached resources.
:param password: The password to use when extracting the repository.
:param directory: Directory within repo where cookiecutter.json lives.
:return: A tuple containing the cookiecutter template directory, and
a boolean describing whether that directory should be cleaned up
after the template has been instantiated.
:raises: `RepositoryNotFound` if a repository directory could not be found.
"""
template = expand_abbreviations(template, abbreviations)
if is_zip_file(template):
unzipped_dir = unzip(
zip_uri=template,
is_url=is_repo_url(template),
clone_to_dir=clone_to_dir,
no_input=no_input,
password=password,
)
repository_candidates = [unzipped_dir]
cleanup = True
elif is_repo_url(template):
cloned_repo = clone(
repo_url=template,
checkout=checkout,
clone_to_dir=clone_to_dir,
no_input=no_input,
)
repository_candidates = [cloned_repo]
cleanup = False
else:
repository_candidates = [template, os.path.join(clone_to_dir, template)]
cleanup = False
if directory:
repository_candidates = [
os.path.join(s, directory) for s in repository_candidates
]
for repo_candidate in repository_candidates:
if repository_has_cookiecutter_json(repo_candidate):
return repo_candidate, cleanup
raise RepositoryNotFound(
'A valid repository for "{}" could not be found in the following '
'locations:\n{}'.format(template, '\n'.join(repository_candidates))
)
cookiecutter-2.6.0/cookiecutter/utils.py 0000664 0000000 0000000 00000005423 14565433335 0020450 0 ustar 00root root 0000000 0000000 """Helper functions used throughout Cookiecutter."""
import contextlib
import logging
import os
import shutil
import stat
import tempfile
from pathlib import Path
from typing import Dict
from jinja2.ext import Extension
from cookiecutter.environment import StrictEnvironment
logger = logging.getLogger(__name__)
def force_delete(func, path, exc_info):
"""Error handler for `shutil.rmtree()` equivalent to `rm -rf`.
Usage: `shutil.rmtree(path, onerror=force_delete)`
From https://docs.python.org/3/library/shutil.html#rmtree-example
"""
os.chmod(path, stat.S_IWRITE)
func(path)
def rmtree(path):
"""Remove a directory and all its contents. Like rm -rf on Unix.
:param path: A directory path.
"""
shutil.rmtree(path, onerror=force_delete)
def make_sure_path_exists(path: "os.PathLike[str]") -> None:
"""Ensure that a directory exists.
:param path: A directory tree path for creation.
"""
logger.debug('Making sure path exists (creates tree if not exist): %s', path)
try:
Path(path).mkdir(parents=True, exist_ok=True)
except OSError as error:
raise OSError(f'Unable to create directory at {path}') from error
@contextlib.contextmanager
def work_in(dirname=None):
"""Context manager version of os.chdir.
When exited, returns to the working directory prior to entering.
"""
curdir = os.getcwd()
try:
if dirname is not None:
os.chdir(dirname)
yield
finally:
os.chdir(curdir)
def make_executable(script_path):
"""Make `script_path` executable.
:param script_path: The file to change
"""
status = os.stat(script_path)
os.chmod(script_path, status.st_mode | stat.S_IEXEC)
def simple_filter(filter_function):
"""Decorate a function to wrap it in a simplified jinja2 extension."""
class SimpleFilterExtension(Extension):
def __init__(self, environment):
super().__init__(environment)
environment.filters[filter_function.__name__] = filter_function
SimpleFilterExtension.__name__ = filter_function.__name__
return SimpleFilterExtension
def create_tmp_repo_dir(repo_dir: "os.PathLike[str]") -> Path:
"""Create a temporary dir with a copy of the contents of repo_dir."""
repo_dir = Path(repo_dir).resolve()
base_dir = tempfile.mkdtemp(prefix='cookiecutter')
new_dir = f"{base_dir}/{repo_dir.name}"
logger.debug(f'Copying repo_dir from {repo_dir} to {new_dir}')
shutil.copytree(repo_dir, new_dir)
return Path(new_dir)
def create_env_with_context(context: Dict):
"""Create a jinja environment using the provided context."""
envvars = context.get('cookiecutter', {}).get('_jinja2_env_vars', {})
return StrictEnvironment(context=context, keep_trailing_newline=True, **envvars)
cookiecutter-2.6.0/cookiecutter/vcs.py 0000664 0000000 0000000 00000010476 14565433335 0020107 0 ustar 00root root 0000000 0000000 """Helper functions for working with version control systems."""
import logging
import os
import subprocess # nosec
from pathlib import Path
from shutil import which
from typing import Optional
from cookiecutter.exceptions import (
RepositoryCloneFailed,
RepositoryNotFound,
UnknownRepoType,
VCSNotInstalled,
)
from cookiecutter.prompt import prompt_and_delete
from cookiecutter.utils import make_sure_path_exists
logger = logging.getLogger(__name__)
BRANCH_ERRORS = [
'error: pathspec',
'unknown revision',
]
def identify_repo(repo_url):
"""Determine if `repo_url` should be treated as a URL to a git or hg repo.
Repos can be identified by prepending "hg+" or "git+" to the repo URL.
:param repo_url: Repo URL of unknown type.
:returns: ('git', repo_url), ('hg', repo_url), or None.
"""
repo_url_values = repo_url.split('+')
if len(repo_url_values) == 2:
repo_type = repo_url_values[0]
if repo_type in ["git", "hg"]:
return repo_type, repo_url_values[1]
else:
raise UnknownRepoType
else:
if 'git' in repo_url:
return 'git', repo_url
elif 'bitbucket' in repo_url:
return 'hg', repo_url
else:
raise UnknownRepoType
def is_vcs_installed(repo_type):
"""
Check if the version control system for a repo type is installed.
:param repo_type:
"""
return bool(which(repo_type))
def clone(
repo_url: str,
checkout: Optional[str] = None,
clone_to_dir: "os.PathLike[str]" = ".",
no_input: bool = False,
):
"""Clone a repo to the current directory.
:param repo_url: Repo URL of unknown type.
:param checkout: The branch, tag or commit ID to checkout after clone.
:param clone_to_dir: The directory to clone to.
Defaults to the current directory.
:param no_input: Do not prompt for user input and eventually force a refresh of
cached resources.
:returns: str with path to the new directory of the repository.
"""
# Ensure that clone_to_dir exists
clone_to_dir = Path(clone_to_dir).expanduser()
make_sure_path_exists(clone_to_dir)
# identify the repo_type
repo_type, repo_url = identify_repo(repo_url)
# check that the appropriate VCS for the repo_type is installed
if not is_vcs_installed(repo_type):
msg = f"'{repo_type}' is not installed."
raise VCSNotInstalled(msg)
repo_url = repo_url.rstrip('/')
repo_name = os.path.split(repo_url)[1]
if repo_type == 'git':
repo_name = repo_name.split(':')[-1].rsplit('.git')[0]
repo_dir = os.path.normpath(os.path.join(clone_to_dir, repo_name))
if repo_type == 'hg':
repo_dir = os.path.normpath(os.path.join(clone_to_dir, repo_name))
logger.debug(f'repo_dir is {repo_dir}')
if os.path.isdir(repo_dir):
clone = prompt_and_delete(repo_dir, no_input=no_input)
else:
clone = True
if clone:
try:
subprocess.check_output( # nosec
[repo_type, 'clone', repo_url],
cwd=clone_to_dir,
stderr=subprocess.STDOUT,
)
if checkout is not None:
checkout_params = [checkout]
# Avoid Mercurial "--config" and "--debugger" injection vulnerability
if repo_type == "hg":
checkout_params.insert(0, "--")
subprocess.check_output( # nosec
[repo_type, 'checkout', *checkout_params],
cwd=repo_dir,
stderr=subprocess.STDOUT,
)
except subprocess.CalledProcessError as clone_error:
output = clone_error.output.decode('utf-8')
if 'not found' in output.lower():
raise RepositoryNotFound(
f'The repository {repo_url} could not be found, '
'have you made a typo?'
) from clone_error
if any(error in output for error in BRANCH_ERRORS):
raise RepositoryCloneFailed(
f'The {checkout} branch of repository '
f'{repo_url} could not found, have you made a typo?'
) from clone_error
logger.error('git clone failed with error: %s', output)
raise
return repo_dir
cookiecutter-2.6.0/cookiecutter/zipfile.py 0000664 0000000 0000000 00000010544 14565433335 0020752 0 ustar 00root root 0000000 0000000 """Utility functions for handling and fetching repo archives in zip format."""
import os
import tempfile
from pathlib import Path
from typing import Optional
from zipfile import BadZipFile, ZipFile
import requests
from cookiecutter.exceptions import InvalidZipRepository
from cookiecutter.prompt import prompt_and_delete, read_repo_password
from cookiecutter.utils import make_sure_path_exists
def unzip(
zip_uri: str,
is_url: bool,
clone_to_dir: "os.PathLike[str]" = ".",
no_input: bool = False,
password: Optional[str] = None,
):
"""Download and unpack a zipfile at a given URI.
This will download the zipfile to the cookiecutter repository,
and unpack into a temporary directory.
:param zip_uri: The URI for the zipfile.
:param is_url: Is the zip URI a URL or a file?
:param clone_to_dir: The cookiecutter repository directory
to put the archive into.
:param no_input: Do not prompt for user input and eventually force a refresh of
cached resources.
:param password: The password to use when unpacking the repository.
"""
# Ensure that clone_to_dir exists
clone_to_dir = Path(clone_to_dir).expanduser()
make_sure_path_exists(clone_to_dir)
if is_url:
# Build the name of the cached zipfile,
# and prompt to delete if it already exists.
identifier = zip_uri.rsplit('/', 1)[1]
zip_path = os.path.join(clone_to_dir, identifier)
if os.path.exists(zip_path):
download = prompt_and_delete(zip_path, no_input=no_input)
else:
download = True
if download:
# (Re) download the zipfile
r = requests.get(zip_uri, stream=True, timeout=100)
with open(zip_path, 'wb') as f:
for chunk in r.iter_content(chunk_size=1024):
if chunk: # filter out keep-alive new chunks
f.write(chunk)
else:
# Just use the local zipfile as-is.
zip_path = os.path.abspath(zip_uri)
# Now unpack the repository. The zipfile will be unpacked
# into a temporary directory
try:
zip_file = ZipFile(zip_path)
if len(zip_file.namelist()) == 0:
raise InvalidZipRepository(f'Zip repository {zip_uri} is empty')
# The first record in the zipfile should be the directory entry for
# the archive. If it isn't a directory, there's a problem.
first_filename = zip_file.namelist()[0]
if not first_filename.endswith('/'):
raise InvalidZipRepository(
f"Zip repository {zip_uri} does not include a top-level directory"
)
# Construct the final target directory
project_name = first_filename[:-1]
unzip_base = tempfile.mkdtemp()
unzip_path = os.path.join(unzip_base, project_name)
# Extract the zip file into the temporary directory
try:
zip_file.extractall(path=unzip_base)
except RuntimeError:
# File is password protected; try to get a password from the
# environment; if that doesn't work, ask the user.
if password is not None:
try:
zip_file.extractall(path=unzip_base, pwd=password.encode('utf-8'))
except RuntimeError:
raise InvalidZipRepository(
'Invalid password provided for protected repository'
)
elif no_input:
raise InvalidZipRepository(
'Unable to unlock password protected repository'
)
else:
retry = 0
while retry is not None:
try:
password = read_repo_password('Repo password')
zip_file.extractall(
path=unzip_base, pwd=password.encode('utf-8')
)
retry = None
except RuntimeError:
retry += 1
if retry == 3:
raise InvalidZipRepository(
'Invalid password provided for protected repository'
)
except BadZipFile:
raise InvalidZipRepository(
f'Zip repository {zip_uri} is not a valid zip archive:'
)
return unzip_path
cookiecutter-2.6.0/docs/ 0000775 0000000 0000000 00000000000 14565433335 0015162 5 ustar 00root root 0000000 0000000 cookiecutter-2.6.0/docs/AUTHORS.md 0000777 0000000 0000000 00000000000 14565433335 0020506 2../AUTHORS.md ustar 00root root 0000000 0000000 cookiecutter-2.6.0/docs/CODE_OF_CONDUCT.md 0000777 0000000 0000000 00000000000 14565433335 0022766 2../CODE_OF_CONDUCT.md ustar 00root root 0000000 0000000 cookiecutter-2.6.0/docs/CONTRIBUTING.md 0000777 0000000 0000000 00000000000 14565433335 0022052 2../CONTRIBUTING.md ustar 00root root 0000000 0000000 cookiecutter-2.6.0/docs/HISTORY.md 0000777 0000000 0000000 00000000000 14565433335 0020536 2../HISTORY.md ustar 00root root 0000000 0000000 cookiecutter-2.6.0/docs/README.md 0000777 0000000 0000000 00000000000 14565433335 0020126 2../README.md ustar 00root root 0000000 0000000 cookiecutter-2.6.0/docs/__init__.py 0000664 0000000 0000000 00000000035 14565433335 0017271 0 ustar 00root root 0000000 0000000 """Main package for docs."""
cookiecutter-2.6.0/docs/_templates/ 0000775 0000000 0000000 00000000000 14565433335 0017317 5 ustar 00root root 0000000 0000000 cookiecutter-2.6.0/docs/_templates/package.rst_t 0000664 0000000 0000000 00000001744 14565433335 0021775 0 ustar 00root root 0000000 0000000 {%- macro automodule(modname, options) -%}
.. automodule:: {{ modname }}
{%- for option in options %}
:{{ option }}:
{%- endfor %}
{%- endmacro %}
{%- macro toctree(docnames) -%}
.. toctree::
:maxdepth: {{ maxdepth }}
{% for docname in docnames %}
{{ docname }}
{%- endfor %}
{%- endmacro -%}
===
API
===
{%- if modulefirst and not is_namespace %}
{{ automodule(pkgname, automodule_options) }}
{% endif %}
{%- if subpackages %}
Subpackages
-----------
{{ toctree(subpackages) }}
{% endif %}
{%- if submodules %}
This is the Cookiecutter modules API documentation.
{% if separatemodules %}
{{ toctree(submodules) }}
{% else %}
{%- for submodule in submodules %}
{% if show_headings %}
{{- [submodule, "module"] | join(" ") | e | heading(2) }}
{% endif %}
{{ automodule(submodule, automodule_options) }}
{% endfor %}
{%- endif %}
{%- endif %}
{%- if not modulefirst and not is_namespace %}
Module contents
---------------
{{ automodule(pkgname, automodule_options) }}
{% endif %}
cookiecutter-2.6.0/docs/advanced/ 0000775 0000000 0000000 00000000000 14565433335 0016727 5 ustar 00root root 0000000 0000000 cookiecutter-2.6.0/docs/advanced/boolean_variables.rst 0000664 0000000 0000000 00000002545 14565433335 0023136 0 ustar 00root root 0000000 0000000 Boolean Variables
-----------------
.. versionadded:: 2.2.0
Boolean variables are used for answering True/False questions.
Basic Usage
~~~~~~~~~~~
Boolean variables are regular key / value pairs, but with the value being
``True``/``False``.
For example, if you provide the following boolean variable in your
``cookiecutter.json``::
{
"run_as_docker": true
}
you will get the following user input when running Cookiecutter::
run_as_docker [True]:
User input will be parsed by :func:`~cookiecutter.prompt.read_user_yes_no`. The
following values are considered as valid user input:
- ``True`` values: "1", "true", "t", "yes", "y", "on"
- ``False`` values: "0", "false", "f", "no", "n", "off"
The above ``run_as_docker`` boolean variable creates ``cookiecutter.run_as_docker``,
which can be used like this::
{%- if cookiecutter.run_as_docker -%}
# In case of True add your content here
{%- else -%}
# In case of False add your content here
{% endif %}
Cookiecutter is using `Jinja2's if conditional expression `_ to determine the correct ``run_as_docker``.
Input Validation
~~~~~~~~~~~~~~~~
If a non valid value is inserted to a boolean field, the following error will be printed:
.. code-block:: bash
run_as_docker [True]: docker
Error: docker is not a valid boolean
cookiecutter-2.6.0/docs/advanced/calling_from_python.rst 0000664 0000000 0000000 00000001300 14565433335 0023510 0 ustar 00root root 0000000 0000000 .. _calling-from-python:
Calling Cookiecutter Functions From Python
------------------------------------------
You can use Cookiecutter from Python:
.. code-block:: python
from cookiecutter.main import cookiecutter
# Create project from the cookiecutter-pypackage/ template
cookiecutter('cookiecutter-pypackage/')
# Create project from the cookiecutter-pypackage.git repo template
cookiecutter('https://github.com/audreyfeldroy/cookiecutter-pypackage.git')
This is useful if, for example, you're writing a web framework and need to provide developers with a tool similar to `django-admin.py startproject` or `npm init`.
See the :ref:`API Reference ` for more details.
cookiecutter-2.6.0/docs/advanced/choice_variables.rst 0000664 0000000 0000000 00000004724 14565433335 0022752 0 ustar 00root root 0000000 0000000 .. _choice-variables:
Choice Variables
----------------
*New in Cookiecutter 1.1*
Choice variables provide different choices when creating a project.
Depending on a user's choice the template renders things differently.
Basic Usage
~~~~~~~~~~~
Choice variables are regular key / value pairs, but with the value being a list of strings.
For example, if you provide the following choice variable in your ``cookiecutter.json``:
.. code-block:: JSON
{
"license": ["MIT", "BSD-3", "GNU GPL v3.0", "Apache Software License 2.0"]
}
you'd get the following choices when running Cookiecutter::
Select license:
1 - MIT
2 - BSD-3
3 - GNU GPL v3.0
4 - Apache Software License 2.0
Choose from 1, 2, 3, 4 [1]:
Depending on an user's choice, a different license is rendered by Cookiecutter.
The above ``license`` choice variable creates ``cookiecutter.license``, which can be used like this:
.. code-block:: html+jinja
{%- if cookiecutter.license == "MIT" -%}
# Possible license content here
{%- elif cookiecutter.license == "BSD-3" -%}
# More possible license content here
{% endif %}
Cookiecutter is using `Jinja2's if conditional expression `_ to determine the correct license.
The created choice variable is still a regular Cookiecutter variable and can be used like this:
.. code-block:: html+jinja
License
-------
Distributed under the terms of the `{{cookiecutter.license}}`_ license,
Overwriting Default Choice Values
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Choice Variables are overwritable using a :ref:`user-config` file.
For example, a choice variable can be created in ``cookiecutter.json`` by using a list as value:
.. code-block:: JSON
{
"license": ["MIT", "BSD-3", "GNU GPL v3.0", "Apache Software License 2.0"]
}
By default, the first entry in the values list serves as default value in the prompt.
Setting the default ``license`` agreement to *Apache Software License 2.0* can be done using:
.. code-block:: yaml
default_context:
license: "Apache Software License 2.0"
in the :ref:`user-config` file.
The resulting prompt changes and looks like::
Select license:
1 - Apache Software License 2.0
2 - MIT
3 - BSD-3
4 - GNU GPL v3.0
Choose from 1, 2, 3, 4 [1]:
.. note::
As you can see the order of the options changed from ``1 - MIT`` to ``1 - Apache Software License 2.0``. **Cookiecutter** takes the first value in the list as the default.
cookiecutter-2.6.0/docs/advanced/copy_without_render.rst 0000664 0000000 0000000 00000001706 14565433335 0023561 0 ustar 00root root 0000000 0000000 .. _copy-without-render:
Copy without Render
-------------------
*New in Cookiecutter 1.1*
To avoid rendering directories and files of a cookiecutter, the ``_copy_without_render`` key can be used in the ``cookiecutter.json``.
The value of this key accepts a list of Unix shell-style wildcards:
.. code-block:: JSON
{
"project_slug": "sample",
"_copy_without_render": [
"*.html",
"*not_rendered_dir",
"rendered_dir/not_rendered_file.ini"
]
}
**Note**:
Only the content of the files will be copied without being rendered.
The paths are subject to rendering.
This allows you to write:
.. code-block:: JSON
{
"project_slug": "sample",
"_copy_without_render": [
"{{cookiecutter.repo_name}}/templates/*.html",
]
}
In this example, ``{{cookiecutter.repo_name}}`` will be rendered as expected but the html file content will be copied without rendering.
cookiecutter-2.6.0/docs/advanced/dict_variables.rst 0000664 0000000 0000000 00000003303 14565433335 0022433 0 ustar 00root root 0000000 0000000 .. _dict-variables:
Dictionary Variables
--------------------
*New in Cookiecutter 1.5*
Dictionary variables provide a way to define deep structured information when rendering a template.
Basic Usage
~~~~~~~~~~~
Dictionary variables are, as the name suggests, dictionaries of key-value pairs.
The dictionary values can, themselves, be other dictionaries and lists - the data structure can be as deep as you need.
For example, you could provide the following dictionary variable in your ``cookiecutter.json``:
.. code-block:: json
{
"project_slug": "new_project",
"file_types": {
"png": {
"name": "Portable Network Graphic",
"library": "libpng",
"apps": [
"GIMP"
]
},
"bmp": {
"name": "Bitmap",
"library": "libbmp",
"apps": [
"Paint",
"GIMP"
]
}
}
}
The above ``file_types`` dictionary variable creates ``cookiecutter.file_types``, which can be used like this:
.. code-block:: html+jinja
{% for extension, details in cookiecutter.file_types|dictsort %}
Format name:
{{ details.name }}
Extension:
{{ extension }}
Applications:
{% for app in details.apps -%}
{{ app }}
{% endfor -%}
{% endfor %}
Cookiecutter is using `Jinja2's for expression `_ to iterate over the items in the dictionary.
cookiecutter-2.6.0/docs/advanced/directories.rst 0000664 0000000 0000000 00000001523 14565433335 0021776 0 ustar 00root root 0000000 0000000 .. _directories:
Organizing cookiecutters in directories
---------------------------------------
*New in Cookiecutter 1.7*
Cookiecutter introduces the ability to organize several templates in one repository or zip file, separating them by directories.
This allows using symlinks for general files.
Here's an example repository demonstrating this feature::
https://github.com/user/repo-name.git
├── directory1-name/
| ├── {{cookiecutter.project_slug}}/
| └── cookiecutter.json
└── directory2-name/
├── {{cookiecutter.project_slug}}/
└── cookiecutter.json
To activate one of templates within a subdirectory, use the ``--directory`` option:
.. code-block:: bash
cookiecutter https://github.com/user/repo-name.git --directory="directory1-name"
cookiecutter-2.6.0/docs/advanced/hooks.rst 0000664 0000000 0000000 00000011547 14565433335 0020614 0 ustar 00root root 0000000 0000000 Hooks
=====
Cookiecutter hooks are scripts executed at specific stages during the project generation process. They are either Python or shell scripts, facilitating automated tasks like data validation, pre-processing, and post-processing. These hooks are instrumental in customizing the generated project structure and executing initial setup tasks.
Types of Hooks
--------------
+------------------+------------------------------------------+------------------------------------------+--------------------+----------+
| Hook | Execution Timing | Working Directory | Template Variables | Version |
+==================+==========================================+==========================================+====================+==========+
| pre_prompt | Before any question is rendered. | A copy of the repository directory | No | 2.4.0 |
+------------------+------------------------------------------+------------------------------------------+--------------------+----------+
| pre_gen_project | After questions, before template process.| Root of the generated project | Yes | 0.7.0 |
+------------------+------------------------------------------+------------------------------------------+--------------------+----------+
| post_gen_project | After the project generation. | Root of the generated project | Yes | 0.7.0 |
+------------------+------------------------------------------+------------------------------------------+--------------------+----------+
Creating Hooks
--------------
Hooks are added to the ``hooks/`` folder of your template. Both Python and Shell scripts are supported.
**Python Hooks Structure:**
.. code-block::
cookiecutter-something/
├── {{cookiecutter.project_slug}}/
├── hooks
│ ├── pre_prompt.py
│ ├── pre_gen_project.py
│ └── post_gen_project.py
└── cookiecutter.json
**Shell Scripts Structure:**
.. code-block::
cookiecutter-something/
├── {{cookiecutter.project_slug}}/
├── hooks
│ ├── pre_prompt.sh
│ ├── pre_gen_project.sh
│ └── post_gen_project.sh
└── cookiecutter.json
Python scripts are recommended for cross-platform compatibility. However, shell scripts or `.bat` files can be used for platform-specific templates.
Hook Execution
--------------
Hooks should be robust and handle errors gracefully. If a hook exits with a nonzero status, the project generation halts, and the generated directory is cleaned.
**Working Directory:**
* ``pre_prompt``: Scripts run in the root directory of a copy of the repository directory. That allows the rewrite of ``cookiecutter.json`` to your own needs.
* ``pre_gen_project`` and ``post_gen_project``: Scripts run in the root directory of the generated project, simplifying the process of locating generated files using relative paths.
**Template Variables:**
The ``pre_gen_project`` and ``post_gen_project`` hooks support Jinja template rendering, similar to project templates. For instance:
.. code-block:: python
module_name = '{{ cookiecutter.module_name }}'
Examples
--------
**Pre-Prompt Sanity Check:**
A ``pre_prompt`` hook, like the one below in ``hooks/pre_prompt.py``, ensures prerequisites, such as Docker, are installed before prompting the user.
.. code-block:: python
import sys
import subprocess
def is_docker_installed() -> bool:
try:
subprocess.run(["docker", "--version"], capture_output=True, check=True)
return True
except Exception:
return False
if __name__ == "__main__":
if not is_docker_installed():
print("ERROR: Docker is not installed.")
sys.exit(1)
**Validating Template Variables:**
A ``pre_gen_project`` hook can validate template variables. The following script checks if the provided module name is valid.
.. code-block:: python
import re
import sys
MODULE_REGEX = r'^[_a-zA-Z][_a-zA-Z0-9]+$'
module_name = '{{ cookiecutter.module_name }}'
if not re.match(MODULE_REGEX, module_name):
print(f'ERROR: {module_name} is not a valid Python module name!')
sys.exit(1)
**Conditional File/Directory Removal:**
A ``post_gen_project`` hook can conditionally control files and directories. The example below removes unnecessary files based on the selected packaging option.
.. code-block:: python
import os
REMOVE_PATHS = [
'{% if cookiecutter.packaging != "pip" %}requirements.txt{% endif %}',
'{% if cookiecutter.packaging != "poetry" %}poetry.lock{% endif %}',
]
for path in REMOVE_PATHS:
path = path.strip()
if path and os.path.exists(path):
os.unlink(path) if os.path.isfile(path) else os.rmdir(path)
cookiecutter-2.6.0/docs/advanced/human_readable_prompts.rst 0000664 0000000 0000000 00000003041 14565433335 0024172 0 ustar 00root root 0000000 0000000 .. _human-readable-prompts:
Human readable prompts
--------------------------------
You can add human-readable prompts that will be shown to the user for each variable using the ``__prompts__`` key.
For multiple choices questions you can also provide labels for each option.
See the following cookiecutter config as example:
.. code-block:: json
{
"package_name": "my-package",
"module_name": "{{ cookiecutter.package_name.replace('-', '_') }}",
"package_name_stylized": "{{ cookiecutter.module_name.replace('_', ' ').capitalize() }}",
"short_description": "A nice python package",
"github_username": "your-org-or-username",
"full_name": "Firstname Lastname",
"email": "email@example.com",
"init_git": true,
"linting": ["ruff", "flake8", "none"],
"__prompts__": {
"package_name": "Select your package name",
"module_name": "Select your module name",
"package_name_stylized": "Stylized package name",
"short_description": "Short description",
"github_username": "GitHub username or organization",
"full_name": "Author full name",
"email": "Author email",
"command_line_interface": "Add CLI",
"init_git": "Initialize a git repository",
"linting": {
"__prompt__": "Which linting tool do you want to use?",
"ruff": "Ruff",
"flake8": "Flake8",
"none": "No linting tool"
}
}
}
cookiecutter-2.6.0/docs/advanced/index.rst 0000664 0000000 0000000 00000001024 14565433335 0020565 0 ustar 00root root 0000000 0000000 .. Advanced Usage master index
Advanced Usage
==============
Various advanced topics regarding cookiecutter usage.
.. toctree::
:maxdepth: 2
hooks
user_config
calling_from_python
injecting_context
suppressing_prompts
templates_in_context
private_variables
copy_without_render
replay
choice_variables
boolean_variables
dict_variables
templates
template_extensions
directories
jinja_env
new_line_characters
local_extensions
nested_config_files
human_readable_prompts
cookiecutter-2.6.0/docs/advanced/injecting_context.rst 0000664 0000000 0000000 00000002500 14565433335 0023174 0 ustar 00root root 0000000 0000000 .. _injecting-extra-content:
Injecting Extra Context
-----------------------
You can specify an ``extra_context`` dictionary that will override values from ``cookiecutter.json`` or ``.cookiecutterrc``:
.. code-block:: python
cookiecutter(
'cookiecutter-pypackage/',
extra_context={'project_name': 'TheGreatest'},
)
This works as command-line parameters as well:
.. code-block:: bash
cookiecutter --no-input cookiecutter-pypackage/ project_name=TheGreatest
You will also need to add these keys to the ``cookiecutter.json`` or ``.cookiecutterrc``.
Example: Injecting a Timestamp
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you have ``cookiecutter.json`` that has the following keys:
.. code-block:: JSON
{
"timestamp": "{{ cookiecutter.timestamp }}"
}
This Python script will dynamically inject a timestamp value as the project is
generated:
.. code-block:: python
from cookiecutter.main import cookiecutter
from datetime import datetime
cookiecutter(
'cookiecutter-django',
extra_context={'timestamp': datetime.utcnow().isoformat()}
)
How this works:
1. The script uses ``datetime`` to get the current UTC time in ISO format.
2. To generate the project, ``cookiecutter()`` is called, passing the timestamp
in as context via the ``extra_context``` dict.
cookiecutter-2.6.0/docs/advanced/jinja_env.rst 0000664 0000000 0000000 00000000765 14565433335 0021434 0 ustar 00root root 0000000 0000000 .. _jinja-env:
Customizing the Jinja2 environment
----------------------------------------------
The special template variable ``_jinja2_env_vars`` can be used
to customize the [Jinja2 environment](https://jinja.palletsprojects.com/en/3.1.x/api/#jinja2.Environment).
This example shows how to control whitespace with ``lstrip_blocks`` and ``trim_blocks``:
.. code-block:: JSON
{
"project_slug": "sample",
"_jinja2_env_vars": {"lstrip_blocks": true, "trim_blocks": true}
}
cookiecutter-2.6.0/docs/advanced/local_extensions.rst 0000664 0000000 0000000 00000003570 14565433335 0023037 0 ustar 00root root 0000000 0000000 .. _`local extensions`:
Local Extensions
----------------
*New in Cookiecutter 2.1*
A template may extend the Cookiecutter environment with local extensions.
These can be part of the template itself, providing it with more sophisticated custom tags and filters.
To do so, a template author must specify the required extensions in ``cookiecutter.json`` as follows:
.. code-block:: json
{
"project_slug": "Foobar",
"year": "{% now 'utc', '%Y' %}",
"_extensions": ["local_extensions.FoobarExtension"]
}
This example uses a simple module ``local_extensions.py`` which exists in the template root, containing the following (for instance):
.. code-block:: python
from jinja2.ext import Extension
class FoobarExtension(Extension):
def __init__(self, environment):
super(FoobarExtension, self).__init__(environment)
environment.filters['foobar'] = lambda v: v * 2
This will register the ``foobar`` filter for the template.
For many cases, this will be unnecessarily complicated.
It's likely that we'd only want to register a single function as a filter. For this, we can use the ``simple_filter`` decorator:
.. code-block:: json
{
"project_slug": "Foobar",
"year": "{% now 'utc', '%Y' %}",
"_extensions": ["local_extensions.simplefilterextension"]
}
.. code-block:: python
from cookiecutter.utils import simple_filter
@simple_filter
def simplefilterextension(v):
return v * 2
This snippet will achieve the exact same result as the previous one.
For complex use cases, a python module ``local_extensions`` (a folder with an ``__init__.py``) can also be created in the template root.
Here, for example, a module ``main.py`` would have to export all extensions with ``from .main import FoobarExtension, simplefilterextension`` or ``from .main import *`` in the ``__init__.py``.
cookiecutter-2.6.0/docs/advanced/nested_config_files.rst 0000664 0000000 0000000 00000004563 14565433335 0023462 0 ustar 00root root 0000000 0000000 .. _nested-config-files:
Nested configuration files
--------------------------
*New in Cookiecutter 2.5.0*
If you wish to create a hierarchy of templates and use cookiecutter to choose among them,
you need just to specify the key ``templates`` in the main configuration file to reach
the other ones.
Let's imagine to have the following structure::
main-directory/
├── project-1
│ ├── cookiecutter.json
│ ├── {{cookiecutter.project_slug}}
| │ ├── ...
├── package
│ ├── cookiecutter.json
│ ├── {{cookiecutter.project_slug}}
| │ ├── ...
└── cookiecutter.json
It is possible to specify in the main ``cookiecutter.json`` how to reach the other
config files as follows:
.. code-block:: JSON
{
"templates": {
"project-1": {
"path": "./project-1",
"title": "Project 1",
"description": "A cookiecutter template for a project"
},
"package": {
"path": "./package",
"title": "Package",
"description": "A cookiecutter template for a package"
}
}
}
Then, when ``cookiecutter`` is launched in the main directory it will ask to choose
among the possible templates:
.. code-block::
Select template:
1 - Project 1 (A cookiecutter template for a project)
2 - Package (A cookiecutter template for a package)
Choose from 1, 2 [1]:
Once a template is chosen, for example ``1``, it will continue to ask the info required by
``cookiecutter.json`` in the ``project-1`` folder, such as ``project-slug``
Old Format
++++++++++
*New in Cookiecutter 2.2.0*
In the main ``cookiecutter.json`` add a `template` key with the following format:
.. code-block:: JSON
{
"template": [
"Project 1 (./project-1)",
"Project 2 (./project-2)"
]
}
Then, when ``cookiecutter`` is launched in the main directory it will ask to choose
among the possible templates:
.. code-block::
Select template:
1 - Project 1 (./project-1)
2 - Project 2 (./project-2)
Choose from 1, 2 [1]:
Once a template is chosen, for example ``1``, it will continue to ask the info required by
``cookiecutter.json`` in the ``project-1`` folder, such as ``project-slug``
cookiecutter-2.6.0/docs/advanced/new_line_characters.rst 0000664 0000000 0000000 00000001677 14565433335 0023473 0 ustar 00root root 0000000 0000000 .. _new-lines:
Working with line-ends special symbols LF/CRLF
----------------------------------------------
*New in Cookiecutter 2.0*
.. note::
Before version 2.0 Cookiecutter silently used system line end character.
LF for POSIX and CRLF for Windows.
Since version 2.0 this behaviour changed and now can be forced at template level.
By default Cookiecutter checks every file at render stage and uses the same line end as in source.
This allow template developers to have both types of files in the same template.
Developers should correctly configure their ``.gitattributes`` file to avoid line-end character overwrite by git.
The special template variable ``_new_lines`` enforces a specific line ending.
Acceptable variables: ``'\r\n'`` for CRLF and ``'\n'`` for POSIX.
Here is example how to force line endings to CRLF on any deployment:
.. code-block:: JSON
{
"project_slug": "sample",
"_new_lines": "\r\n"
}
cookiecutter-2.6.0/docs/advanced/private_variables.rst 0000664 0000000 0000000 00000003423 14565433335 0023165 0 ustar 00root root 0000000 0000000 .. _private-variables:
Private Variables
-----------------
Cookiecutter allows the definition private variables by prepending an underscore to the variable name.
The user will not be required to fill those variables in.
These can either be not rendered, by using a prepending underscore, or rendered, prepending a double underscore.
For example, the ``cookiecutter.json``:
.. code-block:: JSON
{
"project_name": "Really cool project",
"_not_rendered": "{{ cookiecutter.project_name|lower }}",
"__rendered": "{{ cookiecutter.project_name|lower }}"
}
Will be rendered as:
.. code-block:: JSON
{
"project_name": "Really cool project",
"_not_rendered": "{{ cookiecutter.project_name|lower }}",
"__rendered": "really cool project"
}
The user will only be asked for ``project_name``.
Non-rendered private variables can be used for defining constants.
An example of where you may wish to use private **rendered** variables is creating a Python package repository and want to enforce naming consistency.
To ensure the repository and package name are based on the project name, you could create a ``cookiecutter.json`` such as:
.. code-block:: JSON
{
"project_name": "Project Name",
"__project_slug": "{{ cookiecutter.project_name|lower|replace(' ', '-') }}",
"__package_name": "{{ cookiecutter.project_name|lower|replace(' ', '_') }}",
}
Which could create a structure like this::
project-name
├── Makefile
├── README.md
├── requirements.txt
└── src
├── project_name
│ └── __init__.py
├── setup.py
└── tests
└── __init__.py
The ``README.md`` can then have a plain English project title.
cookiecutter-2.6.0/docs/advanced/replay.rst 0000664 0000000 0000000 00000003375 14565433335 0020765 0 ustar 00root root 0000000 0000000 .. _replay-feature:
Replay Project Generation
-------------------------
*New in Cookiecutter 1.1*
On invocation **Cookiecutter** dumps a json file to ``~/.cookiecutter_replay/`` which enables you to *replay* later on.
In other words, it persists your **input** for a template and fetches it when you run the same template again.
Example for a replay file (which was created via ``cookiecutter gh:hackebrot/cookiedozer``):
.. code-block:: JSON
{
"cookiecutter": {
"app_class_name": "FooBarApp",
"app_title": "Foo Bar",
"email": "raphael@example.com",
"full_name": "Raphael Pierzina",
"github_username": "hackebrot",
"kivy_version": "1.8.0",
"project_slug": "foobar",
"short_description": "A sleek slideshow app that supports swipe gestures.",
"version": "0.1.0",
"year": "2015"
}
}
To fetch this context data without being prompted on the command line you can use either of the following methods.
Pass the according option on the CLI:
.. code-block:: bash
cookiecutter --replay gh:hackebrot/cookiedozer
Or use the Python API:
.. code-block:: python
from cookiecutter.main import cookiecutter
cookiecutter('gh:hackebrot/cookiedozer', replay=True)
This feature comes in handy if, for instance, you want to create a new project from an updated template.
Custom replay file
~~~~~~~~~~~~~~~~~~
*New in Cookiecutter 2.0*
To specify a custom filename, you can use the ``--replay-file`` option:
.. code-block:: bash
cookiecutter --replay-file ./cookiedozer.json gh:hackebrot/cookiedozer
This may be useful to run the same replay file over several machines, in tests or when a user of the template reports a problem.
cookiecutter-2.6.0/docs/advanced/suppressing_prompts.rst 0000664 0000000 0000000 00000002360 14565433335 0023630 0 ustar 00root root 0000000 0000000 .. _suppressing-command-line-prompts:
Suppressing Command-Line Prompts
--------------------------------
To suppress the prompts asking for input, use ``no_input``.
Note: this option will force a refresh of cached resources.
Basic Example: Using the Defaults
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Cookiecutter will pick a default value if used with ``no_input``:
.. code-block:: python
from cookiecutter.main import cookiecutter
cookiecutter(
'cookiecutter-django',
no_input=True,
)
In this case it will be using the default defined in ``cookiecutter.json`` or ``.cookiecutterrc``.
.. note::
values from ``cookiecutter.json`` will be overridden by values from ``.cookiecutterrc``
Advanced Example: Defaults + Extra Context
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you combine an ``extra_context`` dict with the ``no_input`` argument, you can programmatically create the project with a set list of context parameters and without any command line prompts:
.. code-block:: python
cookiecutter('cookiecutter-pypackage/',
no_input=True,
extra_context={'project_name': 'TheGreatest'})
See also :ref:`injecting-extra-content` and the :ref:`API Reference ` for more details.
cookiecutter-2.6.0/docs/advanced/template_extensions.rst 0000664 0000000 0000000 00000007526 14565433335 0023565 0 ustar 00root root 0000000 0000000 .. _`template extensions`:
Template Extensions
-------------------
*New in Cookiecutter 1.4*
A template may extend the Cookiecutter environment with custom `Jinja2 extensions`_.
It can add extra filters, tests, globals or even extend the parser.
To do so, a template author must specify the required extensions in ``cookiecutter.json`` as follows:
.. code-block:: json
{
"project_slug": "Foobar",
"year": "{% now 'utc', '%Y' %}",
"_extensions": ["jinja2_time.TimeExtension"]
}
On invocation Cookiecutter tries to import the extensions and add them to its environment respectively.
In the above example, Cookiecutter provides the additional tag `now`_, after installing the `jinja2_time.TimeExtension`_ and enabling it in ``cookiecutter.json``.
Please note that Cookiecutter will **not** install any dependencies on its own!
As a user you need to make sure you have all the extensions installed, before running Cookiecutter on a template that requires custom Jinja2 extensions.
By default Cookiecutter includes the following extensions:
- ``cookiecutter.extensions.JsonifyExtension``
- ``cookiecutter.extensions.RandomStringExtension``
- ``cookiecutter.extensions.SlugifyExtension``
- ``cookiecutter.extensions.TimeExtension``
- ``cookiecutter.extensions.UUIDExtension``
.. warning::
The above is just an example to demonstrate how this is used. There is no
need to require ``jinja2_time.TimeExtension``, since its functionality is
included by default (by ``cookiecutter.extensions.TimeExtension``) without
needing an extra install.
Jsonify extension
~~~~~~~~~~~~~~~~~
The ``cookiecutter.extensions.JsonifyExtension`` extension provides a ``jsonify`` filter in templates that converts a Python object to JSON:
.. code-block:: jinja
{% {'a': True} | jsonify %}
Would output:
.. code-block:: json
{"a": true}
Random string extension
~~~~~~~~~~~~~~~~~~~~~~~
*New in Cookiecutter 1.7*
The ``cookiecutter.extensions.RandomStringExtension`` extension provides a ``random_ascii_string`` method in templates that generates a random fixed-length string, optionally with punctuation.
Generate a random n-size character string.
Example for n=12:
.. code-block:: jinja
{{ random_ascii_string(12) }}
Outputs:
.. code-block:: text
bIIUczoNvswh
The second argument controls if punctuation and special characters ``!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~`` should be present in the result:
.. code-block:: jinja
{{ random_ascii_string(12, punctuation=True) }}
Outputs:
.. code-block:: text
fQupUkY}W!)!
Slugify extension
~~~~~~~~~~~~~~~~~
The ``cookiecutter.extensions.SlugifyExtension`` extension provides a ``slugify`` filter in templates that converts string into its dashed ("slugified") version:
.. code-block:: jinja
{% "It's a random version" | slugify %}
Would output:
::
it-s-a-random-version
It is different from a mere replace of spaces since it also treats some special characters differently such as ``'`` in the example above.
The function accepts all arguments that can be passed to the ``slugify`` function of `python-slugify`_.
For example to change the output from ``it-s-a-random-version``` to ``it_s_a_random_version``, the ``separator`` parameter would be passed: ``slugify(separator='_')``.
.. _`Jinja2 extensions`: https://jinja.palletsprojects.com/en/latest/extensions/
.. _`now`: https://github.com/hackebrot/jinja2-time#now-tag
.. _`jinja2_time.TimeExtension`: https://github.com/hackebrot/jinja2-time
.. _`python-slugify`: https://pypi.org/project/python-slugify
UUID4 extension
~~~~~~~~~~~~~~~~~~~~~~~
*New in Cookiecutter 1.x*
The ``cookiecutter.extensions.UUIDExtension`` extension provides a ``uuid4()``
method in templates that generates a uuid4.
Generate a uuid4 string:
.. code-block:: jinja
{{ uuid4() }}
Outputs:
.. code-block:: text
83b5de62-31b4-4a1e-83fa-8c548de65a11
cookiecutter-2.6.0/docs/advanced/templates.rst 0000664 0000000 0000000 00000001616 14565433335 0021463 0 ustar 00root root 0000000 0000000 .. _templates:
Templates inheritance (2.2+)
---------------------------------------------------
*New in Cookiecutter 2.2+*
Sometimes you need to extend a base template with a different
configuration to avoid nested blocks.
Cookiecutter introduces the ability to use common templates
using the power of jinja: `extends`, `include` and `super`.
Here's an example repository::
https://github.com/user/repo-name.git
├── {{cookiecutter.project_slug}}/
| └── file.txt
├── templates/
| └── base.txt
└── cookiecutter.json
every file in the `templates` directory will become referable inside the project itself,
and the path should be relative from the `templates` folder like ::
# file.txt
{% extends "base.txt" %}
... or ...
# file.txt
{% include "base.txt" %}
see more on https://jinja.palletsprojects.com/en/2.11.x/templates/
cookiecutter-2.6.0/docs/advanced/templates_in_context.rst 0000664 0000000 0000000 00000002261 14565433335 0023712 0 ustar 00root root 0000000 0000000 .. _templates-in-context-values:
Templates in Context Values
--------------------------------
The values (but not the keys!) of `cookiecutter.json` are also Jinja2 templates.
Values from user prompts are added to the context immediately, such that one context value can be derived from previous values.
This approach can potentially save your user a lot of keystrokes by providing more sensible defaults.
Basic Example: Templates in Context
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Python packages show some patterns for their naming conventions:
- a human-readable project name
- a lowercase, dashed repository name
- an importable, dash-less package name
Here is a `cookiecutter.json` with templated values for this pattern:
.. code-block:: JSON
{
"project_name": "My New Project",
"project_slug": "{{ cookiecutter.project_name|lower|replace(' ', '-') }}",
"pkg_name": "{{ cookiecutter.project_slug|replace('-', '') }}"
}
If the user takes the defaults, or uses `no_input`, the templated values will be:
- `my-new-project`
- `mynewproject`
Or, if the user gives `Yet Another New Project`, the values will be:
- ``yet-another-new-project``
- ``yetanothernewproject``
cookiecutter-2.6.0/docs/advanced/user_config.rst 0000664 0000000 0000000 00000005024 14565433335 0021765 0 ustar 00root root 0000000 0000000 .. _user-config:
User Config
===========
*New in Cookiecutter 0.7*
If you use Cookiecutter a lot, you'll find it useful to have a user config file.
By default Cookiecutter tries to retrieve settings from a `.cookiecutterrc` file in your home directory.
*New in Cookiecutter 1.3*
You can also specify a config file on the command line via ``--config-file``.
.. code-block:: bash
cookiecutter --config-file /home/audreyr/my-custom-config.yaml cookiecutter-pypackage
Or you can set the ``COOKIECUTTER_CONFIG`` environment variable:
.. code-block:: bash
export COOKIECUTTER_CONFIG=/home/audreyr/my-custom-config.yaml
If you wish to stick to the built-in config and not load any user config file at all, use the CLI option ``--default-config`` instead.
Preventing Cookiecutter from loading user settings is crucial for writing integration tests in an isolated environment.
Example user config:
.. code-block:: yaml
default_context:
full_name: "Audrey Roy"
email: "audreyr@example.com"
github_username: "audreyr"
cookiecutters_dir: "/home/audreyr/my-custom-cookiecutters-dir/"
replay_dir: "/home/audreyr/my-custom-replay-dir/"
abbreviations:
pp: https://github.com/audreyfeldroy/cookiecutter-pypackage.git
gh: https://github.com/{0}.git
bb: https://bitbucket.org/{0}
Possible settings are:
``default_context``:
A list of key/value pairs that you want injected as context whenever you generate a project with Cookiecutter.
These values are treated like the defaults in ``cookiecutter.json``, upon generation of any project.
``cookiecutters_dir``
Directory where your cookiecutters are cloned to when you use Cookiecutter with a repo argument.
``replay_dir``
Directory where Cookiecutter dumps context data to, which you can fetch later on when using the
:ref:`replay feature `.
``abbreviations``
A list of abbreviations for cookiecutters.
Abbreviations can be simple aliases for a repo name, or can be used as a prefix, in the form ``abbr:suffix``.
Any suffix will be inserted into the expansion in place of the text ``{0}``, using standard Python string formatting.
With the above aliases, you could use the ``cookiecutter-pypackage`` template simply by saying ``cookiecutter pp``, or ``cookiecutter gh:audreyr/cookiecutter-pypackage``.
The ``gh`` (GitHub), ``bb`` (Bitbucket), and ``gl`` (Gitlab) abbreviations shown above are actually **built in**, and can be used without defining them yourself.
Read also: :ref:`injecting-extra-content`
cookiecutter-2.6.0/docs/case_studies.md 0000664 0000000 0000000 00000003425 14565433335 0020163 0 ustar 00root root 0000000 0000000 # Case Studies
This showcase is where organizations can describe how they are using Cookiecutter.
## [BeeWare](https://beeware.org/)
Building Python tools for platforms like mobile phones and set top boxes requires a lot of boilerplate code just to get the project running. Cookiecutter has enabled us to very quickly stub out a starter project in which running Python code can be placed, and makes maintaining those templates very easy. With Cookiecutter we've been able to deliver support [Android devices](https://github.com/beeware/Python-Android-template), [iOS devices](https://github.com/beeware/Python-iOS-template), tvOS boxes, and we're planning to add native support for iOS and Windows devices in the future.
[BeeWare](https://beeware.org/) is an organization building open source libraries for Python support on all platforms.
## [ChrisDev](https://chrisdev.com/)
Anytime we start a new project we begin with a [Cookiecutter template that generates a Django/Wagtail project](https://github.com/chrisdev/wagtail-cookiecutter-foundation) Our developers like it for maintainability and our designers enjoy being able to spin up new sites using our tool chain very quickly. Cookiecutter is very useful for because it supports both Mac OSX and Windows users.
[ChrisDev](https://chrisdev.com/) is a Trinidad-based consulting agency.
## [OpenStack](https://www.openstack.org/)
OpenStack uses several Cookiecutter templates to generate:
* [Openstack compliant puppet-modules](https://github.com/openstack/puppet-openstack-cookiecutter)
* [Install guides](https://github.com/openstack/installguide-cookiecutter)
* [New tempest plugins](https://github.com/openstack/tempest-plugin-cookiecutter)
[OpenStack](https://www.openstack.org/) is open source software for creating private and public clouds.
cookiecutter-2.6.0/docs/cli_options.rst 0000664 0000000 0000000 00000000202 14565433335 0020230 0 ustar 00root root 0000000 0000000 .. _command_line_options:
Command Line Options
--------------------
.. click:: cookiecutter.__main__:main
:prog: cookiecutter
cookiecutter-2.6.0/docs/conf.py 0000664 0000000 0000000 00000026353 14565433335 0016472 0 ustar 00root root 0000000 0000000 """Documentation build configuration file."""
#
# cookiecutter documentation build configuration file, created by
# sphinx-quickstart on Thu Jul 11 11:31:49 2013.
#
# This file is execfile()d with the current directory set to its containing
# dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import os
import sys
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
# sys.path.insert(0, os.path.abspath('.'))
# For building docs in foreign environments where we don't have all our
# dependencies (like readthedocs), mock out imports that cause sphinx to fail.
# see: https://docs.readthedocs.io/en/latest/faq.html#i-get-import-errors-on-libraries-that-depend-on-c-modules # noqa
# flake8: noqa D107,D105
# Add parent dir to path
cwd = os.getcwd()
parent = os.path.dirname(cwd)
sys.path.append(parent)
import cookiecutter # noqa 402
# -- General configuration ----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or
# your custom ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
'sphinx.ext.coverage',
'sphinx.ext.imgmath',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
'sphinx_click.ext',
'myst_parser',
'sphinxcontrib.apidoc',
'sphinx_autodoc_typehints',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = {'.rst': 'restructuredtext', '.md': 'markdown'}
# The encoding of source files.
# source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = 'cookiecutter'
copyright = '2013-2022, Audrey Roy and Cookiecutter community'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = cookiecutter.__version__
# The full version, including alpha/beta/rc tags.
release = cookiecutter.__version__
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
# today = ''
# Else, today_fmt is used as the format for a strftime call.
# today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
# The reST default role (used for this markup: `text`) to use for all documents
# default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
# add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
# add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
# show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
# modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
# keep_warnings = False
# Suppress nonlocal image warnings
suppress_warnings = ['image.nonlocal_uri']
# -- Options for HTML output --------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'sphinx_rtd_theme'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
# html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# " v documentation".
# html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
# html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
# html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
# html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
# html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
# html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
# html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
# html_additional_pages = {}
# If false, no module index is generated.
# html_domain_indices = True
# If false, no index is generated.
# html_use_index = True
# If true, the index is split into individual pages for each letter.
# html_split_index = False
# If true, links to the reST sources are added to the pages.
# html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
# html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
# html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
# html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
# html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'cookiecutterdoc'
# -- Options for LaTeX output -------------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
# 'preamble': '',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual])
latex_documents = [
(
'index',
'cookiecutter.tex',
'cookiecutter Documentation',
'Audrey Roy and Cookiecutter community',
'manual',
),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
# latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
# latex_use_parts = False
# If true, show page references after internal links.
# latex_show_pagerefs = False
# If true, show URL addresses after external links.
# latex_show_urls = False
# Documents to append as an appendix to all manuals.
# latex_appendices = []
# If false, no module index is generated.
# latex_domain_indices = True
# -- Options for manual page output -------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(
'index',
'cookiecutter',
'cookiecutter Documentation',
['Audrey Roy and Cookiecutter community'],
1,
)
]
# If true, show URL addresses after external links.
# man_show_urls = False
# -- Options for Texinfo output -----------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(
'index',
'cookiecutter',
'cookiecutter Documentation',
'Audrey Roy and Cookiecutter community',
'cookiecutter',
'Creates projects from project templates',
'Miscellaneous',
),
]
# Documents to append as an appendix to all manuals.
# texinfo_appendices = []
# If false, no module index is generated.
# texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
# texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
# texinfo_no_detailmenu = False
# -- Options for Epub output --------------------------------------------------
# Bibliographic Dublin Core info.
epub_title = 'cookiecutter'
epub_author = 'Audrey Roy'
epub_publisher = 'Audrey Roy and Cookiecutter community'
epub_copyright = '2013-2022, Audrey Roy and Cookiecutter community'
# The language of the text. It defaults to the language option
# or en if the language is not set.
# epub_language = ''
# The scheme of the identifier. Typical schemes are ISBN or URL.
# epub_scheme = ''
# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
# epub_identifier = ''
# A unique identification for the text.
# epub_uid = ''
# A tuple containing the cover image and cover page html template filenames.
# epub_cover = ()
# A sequence of (type, uri, title) tuples for the guide element of content.opf.
# epub_guide = ()
# HTML files that should be inserted before the pages created by sphinx.
# The format is a list of tuples containing the path and title.
# epub_pre_files = []
# HTML files that should be inserted after the pages created by sphinx.
# The format is a list of tuples containing the path and title.
# epub_post_files = []
# A list of files that should not be packed into the epub file.
# epub_exclude_files = []
# The depth of the table of contents in toc.ncx.
# epub_tocdepth = 3
# Allow duplicate toc entries.
# epub_tocdup = True
# Fix unsupported image types using the PIL.
# epub_fix_images = False
# Scale large images.
# epub_max_image_width = 0
# If 'no', URL addresses will not be shown.
# epub_show_urls = 'inline'
# If false, no index is generated.
# epub_use_index = True
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"requests": ("https://requests.readthedocs.io/en/latest/", None),
"click": ("https://click.palletsprojects.com/en/latest", None),
}
myst_enable_extensions = [
"tasklist",
"strikethrough",
"fieldlist",
]
myst_heading_anchors = 3
# Apidoc extension config
apidoc_module_dir = "../cookiecutter"
apidoc_output_dir = "."
apidoc_toc_file = False
apidoc_extra_args = ["-t", "_templates"]
autodoc_member_order = "groupwise"
autodoc_typehints = "none"
cookiecutter-2.6.0/docs/cookiecutter.rst 0000664 0000000 0000000 00000004745 14565433335 0020426 0 ustar 00root root 0000000 0000000 cookiecutter package
====================
Submodules
----------
cookiecutter.cli module
-----------------------
.. automodule:: cookiecutter.cli
:members:
:undoc-members:
:show-inheritance:
cookiecutter.config module
--------------------------
.. automodule:: cookiecutter.config
:members:
:undoc-members:
:show-inheritance:
cookiecutter.environment module
-------------------------------
.. automodule:: cookiecutter.environment
:members:
:undoc-members:
:show-inheritance:
cookiecutter.exceptions module
------------------------------
.. automodule:: cookiecutter.exceptions
:members:
:undoc-members:
:show-inheritance:
cookiecutter.extensions module
------------------------------
.. automodule:: cookiecutter.extensions
:members:
:undoc-members:
:show-inheritance:
cookiecutter.find module
------------------------
.. automodule:: cookiecutter.find
:members:
:undoc-members:
:show-inheritance:
cookiecutter.generate module
----------------------------
.. automodule:: cookiecutter.generate
:members:
:undoc-members:
:show-inheritance:
cookiecutter.hooks module
-------------------------
.. automodule:: cookiecutter.hooks
:members:
:undoc-members:
:show-inheritance:
cookiecutter.log module
-----------------------
.. automodule:: cookiecutter.log
:members:
:undoc-members:
:show-inheritance:
cookiecutter.main module
------------------------
.. automodule:: cookiecutter.main
:members:
:undoc-members:
:show-inheritance:
cookiecutter.prompt module
--------------------------
.. automodule:: cookiecutter.prompt
:members:
:undoc-members:
:show-inheritance:
cookiecutter.replay module
--------------------------
.. automodule:: cookiecutter.replay
:members:
:undoc-members:
:show-inheritance:
cookiecutter.repository module
------------------------------
.. automodule:: cookiecutter.repository
:members:
:undoc-members:
:show-inheritance:
cookiecutter.utils module
-------------------------
.. automodule:: cookiecutter.utils
:members:
:undoc-members:
:show-inheritance:
cookiecutter.vcs module
-----------------------
.. automodule:: cookiecutter.vcs
:members:
:undoc-members:
:show-inheritance:
cookiecutter.zipfile module
---------------------------
.. automodule:: cookiecutter.zipfile
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: cookiecutter
:members:
:undoc-members:
:show-inheritance:
cookiecutter-2.6.0/docs/index.rst 0000664 0000000 0000000 00000001546 14565433335 0017031 0 ustar 00root root 0000000 0000000 .. cookiecutter documentation master file, created by
sphinx-quickstart on Thu Jul 11 11:31:49 2013.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Cookiecutter: Better Project Templates
======================================
Cookiecutter creates projects from **cookiecutters** (project templates), e.g. Python package projects from Python package templates.
Basics
------
.. toctree::
:maxdepth: 2
README
overview
installation
usage
cli_options
tutorials/index
advanced/index
troubleshooting
.. _apiref:
API Reference
-------------
.. toctree::
:maxdepth: 2
cookiecutter
Project Info
------------
.. toctree::
:maxdepth: 2
CONTRIBUTING
AUTHORS
HISTORY
case_studies
CODE_OF_CONDUCT
Index
-----
* :ref:`genindex`
* :ref:`modindex`
cookiecutter-2.6.0/docs/installation.rst 0000664 0000000 0000000 00000007573 14565433335 0020431 0 ustar 00root root 0000000 0000000 ============
Installation
============
Prerequisites
-------------
* Python interpreter
* Adjust your path
* Packaging tools
Python interpreter
^^^^^^^^^^^^^^^^^^
Install Python for your operating system.
On Windows and macOS this is usually necessary.
Most Linux distributions come with Python pre-installed.
Consult the official `Python documentation `_ for details.
You can install the Python binaries from `python.org `_.
Alternatively on macOS, you can use the `homebrew `_ package manager.
.. code-block:: bash
brew install python3
Adjust your path
^^^^^^^^^^^^^^^^
Ensure that your ``bin`` folder is on your path for your platform. Typically ``~/.local/`` for UNIX and macOS, or ``%APPDATA%\Python`` on Windows. (See the Python documentation for `site.USER_BASE `_ for full details.)
UNIX and macOS
""""""""""""""
For bash shells, add the following to your ``.bash_profile`` (adjust for other shells):
.. code-block:: bash
# Add ~/.local/ to PATH
export PATH=$HOME/.local/bin:$PATH
Remember to load changes with ``source ~/.bash_profile`` or open a new shell session.
Windows
"""""""
Ensure the directory where cookiecutter will be installed is in your environment's ``Path`` in order to make it possible to invoke it from a command prompt. To do so, search for "Environment Variables" on your computer (on Windows 10, it is under ``System Properties`` --> ``Advanced``) and add that directory to the ``Path`` environment variable, using the GUI to edit path segments.
Example segments should look like ``%APPDATA%\Python\Python3x\Scripts``, where you have your version of Python instead of ``Python3x``.
You may need to restart your command prompt session to load the environment variables.
.. seealso:: See `Configuring Python (on Windows) `_ for full details.
**Unix on Windows**
You may also install `Windows Subsystem for Linux `_ or `GNU utilities for Win32 `_ to use Unix commands on Windows.
Packaging tools
^^^^^^^^^^^^^^^
See the Python Packaging Authority's (PyPA) documentation `Requirements for Installing Packages `_ for full details.
Install cookiecutter
--------------------
At the command line:
.. code-block:: bash
python3 -m pip install --user cookiecutter
Or, if you do not have pip:
.. code-block:: bash
easy_install --user cookiecutter
Though, pip is recommended, easy_install is deprecated.
Or, if you are using conda, first add conda-forge to your channels:
.. code-block:: bash
conda config --add channels conda-forge
Once the conda-forge channel has been enabled, cookiecutter can be installed with:
.. code-block:: bash
conda install cookiecutter
Alternate installations
-----------------------
**Homebrew (Mac OS X only):**
.. code-block:: bash
brew install cookiecutter
**Void Linux:**
.. code-block:: bash
xbps-install cookiecutter
**Pipx (Linux, OSX and Windows):**
.. code-block:: bash
pipx install cookiecutter
Upgrading
---------
from 0.6.4 to 0.7.0 or greater
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
First, read :doc:`HISTORY` in detail.
There are a lot of major changes.
The big ones are:
* Cookiecutter no longer deletes the cloned repo after generating a project.
* Cloned repos are saved into `~/.cookiecutters/`.
* You can optionally create a `~/.cookiecutterrc` config file.
Or with pip:
.. code-block:: bash
python3 -m pip install --upgrade cookiecutter
Upgrade Cookiecutter either with easy_install (deprecated):
.. code-block:: bash
easy_install --upgrade cookiecutter
Then you should be good to go.
cookiecutter-2.6.0/docs/overview.rst 0000664 0000000 0000000 00000003172 14565433335 0017565 0 ustar 00root root 0000000 0000000 ========
Overview
========
Cookiecutter takes a template provided as a directory structure with template-files.
Templates can be located in the filesystem, as a ZIP-file or on a VCS-Server (Git/Hg) like GitHub.
It reads a settings file and prompts the user interactively whether or not to change the settings.
Then it takes both and generates an output directory structure from it.
Additionally the template can provide code (Python or shell-script) to be executed before and after generation (pre-gen- and post-gen-hooks).
Input
-----
This is a directory structure for a simple cookiecutter::
cookiecutter-something/
├── {{ cookiecutter.project_name }}/ <--------- Project template
│ └── ...
├── blah.txt <--------- Non-templated files/dirs
│ go outside
│
└── cookiecutter.json <--------- Prompts & default values
You must have:
- A ``cookiecutter.json`` file.
- A ``{{ cookiecutter.project_name }}/`` directory, where ``project_name`` is defined in your ``cookiecutter.json``.
Beyond that, you can have whatever files/directories you want.
See https://github.com/audreyfeldroy/cookiecutter-pypackage for a real-world example
of this.
Output
------
This is what will be generated locally, in your current directory::
mysomething/ <---------- Value corresponding to what you enter at the
│ project_name prompt
│
└── ... <-------- Files corresponding to those in your
cookiecutter's `{{ cookiecutter.project_name }}/` dir
cookiecutter-2.6.0/docs/requirements.txt 0000664 0000000 0000000 00000000247 14565433335 0020451 0 ustar 00root root 0000000 0000000 sphinx-rtd-theme>=1.0.0
sphinx-click>=4.1.0
myst-parser>=0.17.2
sphinx-autobuild>=2021.3.14
Sphinx>=4.5.0
sphinxcontrib-apidoc>=0.3.0
sphinx-autodoc-typehints>=1.18.2
cookiecutter-2.6.0/docs/troubleshooting.rst 0000664 0000000 0000000 00000002311 14565433335 0021140 0 ustar 00root root 0000000 0000000 ===============
Troubleshooting
===============
I created a cookiecutter, but it doesn't work, and I can't figure out why
-------------------------------------------------------------------------
* Try upgrading to Cookiecutter 0.8.0, which prints better error
messages and has fixes for several common bugs.
I'm having trouble generating Jinja templates from Jinja templates
------------------------------------------------------------------
Make sure you escape things properly, like this::
{{ "{{" }}
Or this::
{% raw %}
{% endraw %}
Or this::
{{ {{ url_for('home') }} }}
See https://jinja.palletsprojects.com/en/latest/templates/#escaping for more info.
You can also use the `_copy_without_render`_ key in your `cookiecutter.json`
file to escape entire files and directories.
.. _`_copy_without_render`: http://cookiecutter.readthedocs.io/en/latest/advanced/copy_without_render.html
Other common issues
-------------------
TODO: add a bunch of common new user issues here.
This document is incomplete. If you have knowledge that could help other users,
adding a section or filing an issue with details would be greatly appreciated.
cookiecutter-2.6.0/docs/tutorials/ 0000775 0000000 0000000 00000000000 14565433335 0017210 5 ustar 00root root 0000000 0000000 cookiecutter-2.6.0/docs/tutorials/index.rst 0000664 0000000 0000000 00000002441 14565433335 0021052 0 ustar 00root root 0000000 0000000 ====================
Tutorials
====================
Tutorials by `@audreyfeldroy`_
.. toctree::
:maxdepth: 2
tutorial1
tutorial2
External Links
--------------
- `Learn the Basics of Cookiecutter by Creating a Cookiecutter`_ - first steps tutorial with example template by `@BruceEckel`_
- `Project Templates Made Easy`_ by `@pydanny`_
- Cookiedozer Tutorials by `@hackebrot`_
- Part 1: `Create your own Cookiecutter template`_
- Part 2: `Extending our Cookiecutter template`_
- Part 3: `Wrapping up our Cookiecutter template`_
.. _`Learn the Basics of Cookiecutter by Creating a Cookiecutter`: https://github.com/BruceEckel/HelloCookieCutter1/blob/master/Readme.rst
.. _`Project Templates Made Easy`: http://www.pydanny.com/cookie-project-templates-made-easy.html
.. _`Create your own Cookiecutter template`: https://raphael.codes/blog/create-your-own-cookiecutter-template/
.. _`Extending our Cookiecutter template`: https://raphael.codes/blog/extending-our-cookiecutter-template/
.. _`Wrapping up our Cookiecutter template`: https://raphael.codes/blog/wrapping-up-our-cookiecutter-template/
.. _`@audreyfeldroy`: https://github.com/audreyfeldroy
.. _`@pydanny`: https://github.com/pydanny
.. _`@hackebrot`: https://github.com/hackebrot
.. _`@BruceEckel`: https://github.com/BruceEckel
cookiecutter-2.6.0/docs/tutorials/tutorial1.rst 0000664 0000000 0000000 00000012143 14565433335 0021667 0 ustar 00root root 0000000 0000000 =============================
Getting to Know Cookiecutter
=============================
.. note:: Before you begin, please install Cookiecutter 0.7.0 or higher.
Instructions are in :doc:`../installation`.
Cookiecutter is a tool for creating projects from *cookiecutters* (project templates).
What exactly does this mean? Read on!
Case Study: cookiecutter-pypackage
-----------------------------------
*cookiecutter-pypackage* is a cookiecutter template that creates the starter boilerplate for a Python package.
.. note:: There are several variations of it, but for this tutorial we'll use
the original version at https://github.com/audreyfeldroy/cookiecutter-pypackage/.
Step 1: Generate a Python Package Project
------------------------------------------
Open your shell and cd into the directory where you'd like to create a starter Python package project.
At the command line, run the cookiecutter command, passing in the link to cookiecutter-pypackage's HTTPS clone URL like this:
.. code-block:: bash
$ cookiecutter https://github.com/audreyfeldroy/cookiecutter-pypackage.git
Local Cloning of Project Template
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
First, cookiecutter-pypackage gets cloned to `~/.cookiecutters/` (or equivalent on Windows).
Cookiecutter does this for you, so sit back and wait.
Local Generation of Project
~~~~~~~~~~~~~~~~~~~~~~~~~~~
When cloning is complete, you will be prompted to enter a bunch of values, such as `full_name`, `email`, and `project_name`.
Either enter your info, or simply press return/enter to accept the default values.
This info will be used to fill in the blanks for your project.
For example, your name and the year will be placed into the LICENSE file.
Step 2: Explore What Got Generated
----------------------------------
In your current directory, you should see that a project got generated:
.. code-block:: bash
$ ls
boilerplate
Looking inside the `boilerplate/` (or directory corresponding to your `project_slug`) directory, you should see something like this:
.. code-block:: bash
$ ls boilerplate/
AUTHORS.rst MANIFEST.in docs tox.ini
CONTRIBUTING.rst Makefile requirements.txt
HISTORY.rst README.rst setup.py
LICENSE boilerplate tests
That's your new project!
If you open the AUTHORS.rst file, you should see something like this:
.. code-block:: rst
=======
Credits
=======
Development Lead
----------------
* Audrey Roy
Contributors
------------
None yet. Why not be the first?
Notice how it was auto-populated with your (or my) name and email.
Also take note of the fact that you are looking at a ReStructuredText file.
Cookiecutter can generate a project with text files of any type.
Great, you just generated a skeleton Python package.
How did that work?
Step 3: Observe How It Was Generated
------------------------------------
Let's take a look at cookiecutter-pypackage together. Open https://github.com/audreyfeldroy/cookiecutter-pypackage in a new browser window.
{{ cookiecutter.project_slug }}
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Find the directory called `{{ cookiecutter.project_slug }}`.
Click on it.
Observe the files inside of it.
You should see that this directory and its contents corresponds to the project that you just generated.
This happens in `find.py`, where the `find_template()` method looks for the first jinja-like directory name that starts with `cookiecutter`.
AUTHORS.rst
~~~~~~~~~~~
Look at the raw version of `{{ cookiecutter.project_slug }}/AUTHORS.rst`, at
https://raw.github.com/audreyfeldroy/cookiecutter-pypackage/master/%7B%7Bcookiecutter.project_slug%7D%7D/AUTHORS.rst.
Observe how it corresponds to the `AUTHORS.rst` file that you generated.
cookiecutter.json
~~~~~~~~~~~~~~~~~
Now navigate back up to `cookiecutter-pypackage/` and look at the `cookiecutter.json` file.
You should see JSON that corresponds to the prompts and default values shown earlier during project generation:
.. code-block:: json
{
"full_name": "Audrey Roy Greenfeld",
"email": "aroy@alum.mit.edu",
"github_username": "audreyr",
"project_name": "Python Boilerplate",
"project_slug": "{{ cookiecutter.project_name.lower().replace(' ', '_') }}",
"project_short_description": "Python Boilerplate contains all the boilerplate you need to create a Python package.",
"pypi_username": "{{ cookiecutter.github_username }}",
"version": "0.1.0",
"use_pytest": "n",
"use_pypi_deployment_with_travis": "y",
"create_author_file": "y",
"open_source_license": ["MIT", "BSD", "ISCL", "Apache Software License 2.0", "Not open source"]
}
Questions?
----------
If anything needs better explanation, please take a moment to file an issue at https://github.com/audreyfeldroy/cookiecutter/issues with what could be improved
about this tutorial.
Summary
-------
You have learned how to use Cookiecutter to generate your first project from a cookiecutter project template.
In tutorial 2 (:ref:`tutorial2`), you'll see how to create cookiecutters of your own, from scratch.
cookiecutter-2.6.0/docs/tutorials/tutorial2.rst 0000664 0000000 0000000 00000007311 14565433335 0021671 0 ustar 00root root 0000000 0000000 .. _tutorial2:
==================================
Create a Cookiecutter From Scratch
==================================
In this tutorial, we are creating `cookiecutter-website-simple`, a cookiecutter for generating simple, bare-bones websites.
Step 1: Name Your Cookiecutter
------------------------------
Create the directory for your cookiecutter and cd into it:
.. code-block:: bash
$ mkdir cookiecutter-website-simple
$ cd cookiecutter-website-simple/
Step 2: Create cookiecutter.json
----------------------------------
`cookiecutter.json` is a JSON file that contains fields which can be referenced in the cookiecutter template. For each, default value is defined and user will be prompted for input during cookiecutter execution. Only mandatory field is `project_slug` and it should comply with package naming conventions defined in `PEP8 Naming Conventions `_ .
.. code-block:: json
{
"project_name": "Cookiecutter Website Simple",
"project_slug": "{{ cookiecutter.project_name.lower().replace(' ', '_') }}",
"author": "Anonymous"
}
Step 3: Create project_slug Directory
---------------------------------------
Create a directory called `{{ cookiecutter.project_slug }}`.
This value will be replaced with the repo name of projects that you generate from this cookiecutter.
Step 4: Create index.html
--------------------------
Inside of `{{ cookiecutter.project_slug }}`, create `index.html` with following content:
.. code-block:: html
{{ cookiecutter.project_name }}
{{ cookiecutter.project_name }}
by {{ cookiecutter.author }}
Step 5: Pack cookiecutter into ZIP
----------------------------------
There are many ways to run Cookiecutter templates, and they are described in details in `Usage chapter `_. In this tutorial we are going to ZIP cookiecutter and then run it for testing.
By running following command `cookiecutter.zip` will get generated which can be used to run cookiecutter. Script will generate `cookiecutter.zip` ZIP file and echo full path to the file.
.. code-block:: bash
$ (SOURCE_DIR=$(basename $PWD) ZIP=cookiecutter.zip && # Set variables
pushd .. && # Set parent directory as working directory
zip -r $ZIP $SOURCE_DIR --exclude $SOURCE_DIR/$ZIP --quiet && # ZIP cookiecutter
mv $ZIP $SOURCE_DIR/$ZIP && # Move ZIP to original directory
popd && # Restore original work directory
echo "Cookiecutter full path: $PWD/$ZIP")
Step 6: Run cookiecutter
------------------------
Set your work directory to whatever directory you would like to run cookiecutter at. Use cookiecutter full path and run the following command:
.. code-block:: bash
$ cookiecutter
You can expect similar output:
.. code-block:: bash
$ cookiecutter /Users/admin/cookiecutter-website-simple/cookiecutter.zip
project_name [Cookiecutter Website Simple]: Test web
project_slug [test_web]:
author [Anonymous]: Cookiecutter Developer
Resulting directory should be inside your work directory with a name that matches `project_slug` you defined. Inside that directory there should be `index.html` with generated source:
.. code-block:: html
Test web
