cookiecutter v1.7.0 Release Notes
Release Date: 2019-12-22 // 4 months ago-
Important changes
- ⬇️ Drop support for EOL Python 3.3, 3.4, thanks to @hugovk, @jamescurtin and @insspb (#1024)
- Prevent
clickAPI v7.0 from showing choices when already shown, thanks to @rly and @luzfcb (#1168) - 👉 Make sure to preserve the order of items in the generated cookiecutter context, thanks to @hackebrot (#1074)
- 🛠 Fixed DeprecationWarning for a regular expression on python 3.6, thanks to @reinout (#1124)
- 👉 Use io.open contextmanager when reading hook files, thanks to @jcb91 (#1147)
PEP related changes
- 📄 PEP257 fixing docstrings in exceptions.py. Thanks to @MinchinWeb (#1237)
- 📄 PEP257 fixing docstrings in replay.py. Thanks to @kishan (#1234)
- ✅ PEP257 fixing docstrings in test_unzip.py. Thanks to @tonytheleg and @insspb (#1236, #1262)
- Update docstrings in
cookiecutter/main.py,cookiecutter/ __init__.py, andcookiecutter/log.pyto follow the PEP 257 style guide, thanks to @meahow (#998, #999, #1000) - 💅 Update docstrings in
cookiecutter/utils.pyto follow the PEP 257 style guide, thanks to @dornheimer(#1026) - ⚡️ Update prompt.py to match pep257 guidelines, thanks to @jairideout (#1105)
📚 Documentation changes
- ⚡️ Updates REAMDE.md with svg badge for appveyor. Thanks to @sobolevn (#1254)
- ➕ Add missing
{% endif %}to Choice Variables example. Thanks to @mattstibbs (#1249) - 📚 Core documentation converted to Markdown format thanks to @wagnernegrao, @insspb (#1216)
- Add a CODE_OF_CONDUCT.md file to the project, thanks to @andreagrandi (#1009)
- Fix grammar in Choice Variables documentation, thanks to @jubrilissa (#1011)
- ⚡️ Update installation docs with links to the Windows Subsystem and GNU utilities, thanks to @Nythiennzo for the PR and @BruceEckel for the review (#1016)
- ⚡️ Update tutorial with explanation for how cookiecutter finds the template file, thanks to @accraze(#1025)
- 👌 Improve user documentation for writing hooks, thanks to @jonathansick (#1057)
- Document use of cookiecutter-template topic on GitHub, thanks to @ssbarnea (#1189)
- ⚡️ Update README badge links, thanks to @luzfcb (#1207)
- 📚 Update link to Jinja2 extensions documentation, thanks to @dacog (#1193)
✅ Tests changes
- 🛠 Fixed tests sequence for appveyor, to exclude file not found bug. Thanks to @insspb (#1257)
- ⚡️ Tests update: use sys.executable when invoking python in python 3 only environment thanks to @vincentbernat (#1221)
- ✅ Test the codebase with python3.8 beta on tox and travis-ci (#1206), thanks to @mihrab34
- Require pip 9.0.0 or newer for tox environments, thanks to @hackebrot (#1215)
- ⬆️ Upgrade flake8 to version 3.5.0, thanks to @cclauss (#1038)
- ⚡️ Update CI config files to use
TOXENVenvironment variable, thanks to @asottile (#1019)
Templates list modification
- ➕ Add more cookiecutter templates to the mix:
- cookiecutter-python-cli by @xuanluong (#1003)
- cookiecutter-docker-science by @takahi-i (#1040)
- cookiecutter-flask-skeleton by @mjhea0 (#1052)
- cookiecutter-awesome by @Pawamoy (#1051)
- cookiecutter-flask-ask by @machinekoder (#1056)
- cookiecutter-data-driven-journalism by @JAStark (#1020)
- cookiecutter-tox-plugin by @obestwalter (#1103)
- cookiecutter-django-dokku by @mashrikt (#1093)
Previous changes from v1.6.0
-
🚀 The primary goal of this release was to add support for templates from Zip files or Zip URLs.
🆕 New Features
- Include template path or template URL in cookiecutter context under
_template, thanks to @aroig (#774) - ➕ Add a URL abbreviation for GitLab template projects, thanks to @hackebrot (#963)
- ➕ Add option to use templates from Zip files or Zip URLs, thanks to @freakboy3742 (#961)
🐛 Bug Fixes
- 🛠 Fix an issue with missing default template abbreviations for when a user defined custom abbreviations, thanks to @noirbizarre for the issue report and @hackebrot for the fix (#966, #967)
- Preserve existing output directory on project generation failure, thanks to @ionelmc for the report and @michaeljoseph for the fix (#629, #964)
- 🛠 Fix Python 3.x error handling for
gitoperation failures, thanks to @jmcarp (#905)
Other Changes
- Fix broken link to Copy without Render docs, thanks to @coreysnyder04 (#912)
- 👌 Improve debug log message for when a hook is not found, thanks to @raphigaziano (#160)
- 🛠 Fix module summary and
expand_abbreviations()doc string as per pep257, thanks to @terryjbates (#772) - ⚡️ Update doc strings in
cookiecutter/cli.pyandcookiecutter/config.pyaccording to pep257, thanks to @terryjbates (#922, #931) - Update doc string for
is_copy_only_path()according to pep257, thanks to @mathagician and @terryjbates (#935, #949) - ⚡️ Update doc strings in
cookiecutter/extensions.pyaccording to pep257, thanks to @meahow (#996) - 🛠 Fix miscellaneous issues with building docs, thanks to @stevepiercy (#889)
- ⚡️ Re-implement Makefile and update several make rules, thanks to @hackebrot (#930)
- 🛠 Fix broken link to pytest docs, thanks to @eyalev for the issue report and @devstrat for the fix (#939, #940)
- ➕ Add
test_requirements.txtfile for easier testing outside of tox, thanks to @ramnes (#945) - Improve wording in copy without render docs, thanks to @eyalev (#938)
- 🛠 Fix a number of typos, thanks to @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 for the report and fix (#863, #864) - ➕ Added more cookiecutter templates to the mix:
- cookiecutter-kata-cpputest by @13coders (#901)
- cookiecutter-kata-gtest by @13coders (#901)
- cookiecutter-pyramid-talk-python-starter by @mikeckennedy (#915)
- cookiecutter-android by @alexfu (#890)
- cookiecutter-lux-python by @alexkey (#895)
- cookiecutter-git by @tuxredux (#921)
- cookiecutter-ansible-role-ci by @ferrarimarco (#903)
- cookiecutter_dotfile by @bdcaf (#925)
- painless-continuous-delivery by @painless-software (#927)
- cookiecutter-molecule by @retr0h (#954)
- sublime-snippet-package-template by @agenoria (#956)
- cookiecutter-conda-python by @conda (#969)
- cookiecutter-flask-minimal by @candidtim (#977)
- cookiecutter-pypackage-rust-cross-platform-publish by @mckaymatt (#957)
- cookie-cookie by @tuxredux (#951)
- cookiecutter-telegram-bot by @Ars2014 (#984)
- python-project-template by @Kwpolska (#986)
- wemake-django-template by @wemake-services (#990)
- cookiecutter-raml by @genzj (#994)
- cookiecutter-anyblok-project by @AnyBlok (#988)
- cookiecutter-devenv by @greenguavalabs (#991)
- Include template path or template URL in cookiecutter context under