History¶
1.6.0 (2017-10-15) Tim Tam¶
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)
1.5.1 (2017-02-04) Alfajor¶
New Features:
- Major update to installation documentation, thanks to @stevepiercy (#880)
Bug Fixes:
- Resolve an issue around default values for dict variables, thanks to @e-kolpakov for raising the issue and @hackebrot for the PR (#882, #884)
Other Changes:
- Contributor documentation reST fixes, thanks to @stevepiercy (#878)
- Added more cookiecutter templates to the mix:
- widget-cookiecutter by @willingc (#781)
- cookiecutter-django-foundation by @Parbhat (#804)
- cookiecutter-tornado by @hkage (#807)
- cookiecutter-django-ansible by @Ivaylo-Bachvarov (#816)
- CICADA by @elenimijalis (#840)
- cookiecutter-tf-module by @VDuda (#843)
- cookiecutter-pyqt4 by @aeroaks (#847)
- cookiecutter-golang by @mjhea0 and @lacion (#872, #873)
- cookiecutter-elm, cookiecutter-java and cookiecutter-spring-boot by @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 and @michaeljoseph (#666).
- Updated conda installation instructions to work with the new conda-forge distribution of Cookiecutter, thanks to @pydanny and especially @bollwyvl (#232, #705).
- Refactor code responsible for interaction with version control systems and raise better error messages, thanks to @michaeljoseph (#778).
- Add support for executing cookiecutter using
python -m cookiecutteror from a checkout/zip file, thanks to @brettcannon (#788). - New CLI option
--debug-file PATHto store a log file on disk. By default no log file is written. Entries forDEBUGlevel and higher. Thanks to @hackebrot (#792). - Existing templates in a user’s
cookiecutters_dir(default is~/.cookiecutters/) can now be referenced by directory name, thanks to @michaeljoseph (#825). - Add support for dict values in
cookiecutter.json, thanks to @freakboy3742 and @hackebrot (#815, #858). - Add a
jsonifyfilter to default jinja2 extensions that json.dumps a Python object into a string, thanks to @aroig (#791).
Bug Fixes:
- Fix typo in the error logging text for when a hook did not exit successfully, thanks to @luzfcb (#656)
- Fix an issue around replay file names when cookiecutter is used with a relative path to a template, thanks to @eliasdorneles for raising the issue and @hackebrot for the PR (#752, #753)
- Ignore hook files with tilde-suffixes, thanks to @hackebrot (#768)
- Fix a minor issue with the code that generates a name for a template, thanks to @hackebrot (#798)
- Handle empty hook file or other OS errors, thanks to @christianmlong for raising this bug and @jcarbaugh and