Important Changes:
- Drop support for EOL Python 3.3, thanks to @hugovk (#1024)
Other Changes:
- Add a CODE_OF_CONDUCT.md file to the project, thanks to @andreagrandi (#1009)
- Update docstrings in
cookiecutter/main.py
,cookiecutter/__init__.py
, andcookiecutter/log.py
to follow the PEP 257 style guide, thanks to @meahow (#998, #999, #1000) - Update docstrings in
cookiecutter/utils.py
to follow the PEP 257 style guide, thanks to @dornheimer (#1026) - 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)
- Upgrade flake8 to version 3.5.0, thanks to @cclauss (#1038)
- Update tutorial with explanation for how cookiecutter finds the template file, thanks to @accraze (#1025)
- Update CI config files to use
TOXENV
environment variable, thanks to @asottile (#1019) - Improve user documentation for writing hooks, thanks to @jonathansick (#1057)
- Make sure to preserve the order of items in the generated cookiecutter context, thanks to @hackebrot (#1074)
- 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)
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
git
operation 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.py
andcookiecutter/config.py
according 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.py
according 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.txt
file 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)
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)
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 cookiecutter
or from a checkout/zip file, thanks to @brettcannon (#788). - New CLI option
--debug-file PATH
to store a log file on disk. By default no log file is written. Entries forDEBUG
level 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
jsonify
filter 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 @hackebrot for the fix (#632, #729, #862)
- Resolve an issue with custom extensions not being loaded for
pre_gen_project
andpost_gen_project
hooks, thanks to @cheungnj (#860)
Other Changes:
- Remove external dependencies from tests, so that tests can be run w/o network connection, thanks to @hackebrot (#603)
- Remove execute permissions on Python files, thanks to @mozillazg (#650)
- Report code coverage info from AppVeyor build to codecov, thanks to @ewjoachim (#670)
- Documented functions and methods lacking documentation, thanks to @pydanny (#673)
- Documented
__init__
methods for Environment objects, thanks to @pydanny (#677) - Updated whichcraft to 0.4.0, thanks to @pydanny.
- Updated documentation link to Read the Docs, thanks to @natim (#687)
- Moved cookiecutter templates and added category links, thanks to @willingc (#674)
- Added Github Issue Template, thanks to @luzfcb (#700)
- Added
ssh
repository examples, thanks to @pokoli (#702) - Fix links to the cookiecutter-data-science template and its documentation, thanks to @tephyr for the PR and @willingc for the review (#711, #714)
- Update link to docs for Django's
--template
command line option, thanks to @purplediane (#754) - Create hook backup files during the tests as opposed to having them as static files in the repository, thanks to @hackebrot (#789)
- Applied PEP 257 docstring conventions to:
environment.py
, thanks to @terryjbates (#759)find.py
, thanks to @terryjbates (#761)generate.py
, thanks to @terryjbates (#764)hooks.py
, thanks to @terryjbates (#766)repository.py
, thanks to @terryjbates (#833)vcs.py
, thanks to @terryjbates (#831)
- Fix link to the Tryton cookiecutter, thanks to @cedk and @nicoe (#697, #698)
- Added PyCon US 2016 sponsorship to README, thanks to @purplediane (#720)
- Added a sprint contributor doc, thanks to @phoebebauer (#727)
- Converted readthedocs links (.org -> .io), thanks to @adamchainz (#718)
- Added Python 3.6 support, thanks to @suledev (#728)
- Update occurrences of
repo_name
in documentation, thanks to @palmerev (#734) - Added case studies document, thanks to @pydanny (#735)
- Added first steps cookiecutter creation tutorial, thanks to @BruceEckel (#736)
- Reorganised tutorials and setup git submodule to external tutorial, thanks to @dot2dotseurat (#740)
- Debian installation instructions, thanks to @ivanlyon (#738)
- Usage documentation typo fix., thanks to @terryjbates (#739)
- Updated documentation copyright date, thanks to @zzzirk (#747)
- Add a make rule to update git submodules, thanks to @hackebrot (#746)
- Split up advanced usage docs, thanks to @zzzirk (#749)
- Documentation for the
no_input
option, thanks to @pokoli (#701) - Remove unnecessary shebangs from python files, thanks to @michaeljoseph (#763)
- Refactor cookiecutter template identification, thanks to @michaeljoseph (#777)
- Add a
cli_runner
test fixture to simplify CLI tests, thanks to @hackebrot (#790) - Add a check to ensure cookiecutter repositories have JSON context, thanks to @michaeljoseph (#782)
- Rename the internal function that determines whether a file should be rendered, thanks to @audreyr for raising the issue and @hackebrot for the PR (#741, #802)
- Fix typo in docs, thanks to @mwarkentin (#828)
- Fix broken link to Invoke docs, thanks to @B3QL (#820)
- Add documentation to
render_variable
function inprompt.py
, thanks to @pydanny (#678) - Fix python3.6 travis-ci and tox configuration, thanks to @luzfcb (#844)
- Add missing encoding declarations to python files, thanks to @andytom (#852)
- Disable poyo logging for tests, thanks to @hackebrot (#855)
- Remove pycache directories in make clean-pyc, thanks to @hackebrot (#849)
- Refactor hook system to only find the requested hook, thanks to @michaeljoseph (#834)
- Add tests for custom extensions in
pre_gen_project
andpost_gen_project
hooks, thanks to @hackebrot (#856) - Make the build reproducible by avoiding nondeterministic keyword arguments, thanks to @lamby and @hackebrot (#800, #861)
- Extend CLI help message and point users to the github project to engage with the community, thanks to @hackebrot (#859)
- Added more cookiecutter templates to the mix:
- cookiecutter-funkload-friendly by @tokibito (#657)
- cookiecutter-reveal.js by @keimlink (#660)
- cookiecutter-python-app by @mdklatt (#659)
- morepath-cookiecutter by @href (#672)
- hovercraft-slides by @jhermann (#665)
- cookiecutter-es6-package by @ratson (#667)
- cookiecutter-webpack by @hzdg (#668)
- cookiecutter-django-herokuapp by @dulaccc (#374)
- cookiecutter-django-aws-eb by @peterlauri (#626)
- wagtail-starter-kit by @tkjone (#658)
- cookiecutter-dpf-effect by @SpotlightKid (#663)
- cookiecutter-dpf-audiotk by @SpotlightKid (#663)
- cookiecutter-template by @eviweb (#664)
- cookiecutter-angular2 by @matheuspoleza (#675)
- cookiecutter-data-science by @pjbull (#680)
- cc_django_ember_app by @nanuxbe (#686)
- cc_project_app_drf by @nanuxbe (#686)
- cc_project_app_full_with_hooks by @nanuxbe (#686)
- beat-generator by @ruflin (#695)
- cookiecutter-scala by @Plippe (#751)
- cookiecutter-snakemake-analysis-pipeline by @xguse (#692)
- cookiecutter-py3tkinter by @ivanlyon (#730)
- pyramid-cookiecutter-alchemy by @stevepiercy (#745)
- pyramid-cookiecutter-starter by @stevepiercy (#745)
- pyramid-cookiecutter-zodb by @stevepiercy (#745)
- substanced-cookiecutter by @stevepiercy (#745)
- cookiecutter-simple-django-cn by @shenyushun (#765)
- cookiecutter-pyqt5 by @mandeepbhutani (#797)
- cookiecutter-xontrib by @laerus (#817)
- cookiecutter-reproducible-science by @mkrapp (#826)
- cc-automated-drf-template by @elenimijalis (#832)
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 (#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 (#111, #586, #592)
- Uses strict Jinja2 env in prompt, thanks to @hackebrot (#598, #613)
- Switched from pyyaml/ruamel.yaml libraries that were problematic across platforms to the pure Python poyo library, thanks to @hackebrot (#557, #569, #621)
- User config values for
cookiecutters_dir
andreplay_dir
now support environment variable and user home expansion, thanks to @nfarrar for the suggestion and @hackebrot for the PR (#640, #642) - Add jinja2-time as default extension for dates and times in templates via
{% now 'utc' %}
, thanks to @hackebrot (#653)
Bug Fixes:
- Provided way to define options that have no defaults, thanks to @johtso (#587, #588)
- Make sure that
replay.dump()
andreplay.load()
use the correct user config, thanks to @hackebrot (#590, #594) - Added correct CA bundle for Git on Appveyor, thanks to @maiksensi (#599, #602)
- Open
HISTORY.rst
withutf-8
encoding when reading the changelog, thanks to @0-wiz-0 for submitting the issue and @hackebrot for the fix (#638, #639) - Fix repository indicators for private repository urls, thanks to @habnabit for the fix (#595) and @hackebrot for the tests (#655)
Other Changes:
- Set path before running tox, thanks to @maiksensi (#615, #620)
- Removed xfail in test_cookiecutters, thanks to @hackebrot (#618)
- Removed django-cms-plugin on account of 404 error, thanks to @mativs and @pydanny (#593)
- Fixed docs/usage.rst, thanks to @macrotim (#604)
- Update .gitignore to latest Python.gitignore and ignore PyCharm files, thanks to @audreyr
- Use open context manager to read context_file in generate() function, thanks to @hackebrot (#607, #608)
- Added documentation for choice variables, thanks to @maiksensi (#611)
- Set up Scrutinizer to check code quality, thanks to @audreyr
- Drop distutils support in setup.py, thanks to @hackebrot (#606, #609)
- Change cookiecutter-pypackage-minimal link, thanks to @kragniz (#614)
- Fix typo in one of the template's description, thanks to @ryanfreckleton (#643)
- Fix broken link to _copy_without_render in troubleshooting.rst, thanks to @ptim (#647)
- Added more cookiecutter templates to the mix:
- cookiecutter-pipproject by @wdm0006 (#624)
- cookiecutter-flask-2 by @wdm0006 (#624)
- cookiecutter-kotlin-gradle by @thomaslee (#622)
- cookiecutter-tryton-fulfilio by @cedk (#631)
- django-starter by @tkjone (#635)
- django-docker-bootstrap by @legios89 (#636)
- cookiecutter-mediawiki-extension by @JonasGroeger (#645)
- cookiecutter-django-gulp by @valerymelou (#648)
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
orpost_gen_project
hook scripts fail, thanks to @eliasdorneles (#464, #549) - Extend user config capabilities with additional cli options
--config-file
and--default-config
and environment variableCOOKIECUTTER_CONFIG
, thanks to @jhermann, @pfmoore, and @hackebrot (#258, #424, #565)
Bug Fixes:
- Fixed conditional dependencies for wheels in setup.py, thanks to @hackebrot (#557, #568)
- Reverted skipif markers to use correct reasons (bug fixed in pytest), thanks to @hackebrot (#574)
Other Changes:
- Improved path and documentation for rendering the Sphinx documentation, thanks to @eliasdorneles and @hackebrot (#562, #583)
- Added additional help entrypoints, thanks to @michaeljoseph (#563, #492)
- Added Two Scoops Academy to the README, thanks to @hackebrot (#576)
- Now handling trailing slash on URL, thanks to @ramiroluz (#573, #546)
- Support for testing x86 and x86-64 architectures on appveyor, thanks to @maiksensi (#567)
- Made tests work without installing Cookiecutter, thanks to @vincentbernat (#550)
- Encoded the result of the hook template to utf8, thanks to @ionelmc (#577. #578)
- Added test for _run_hook_from_repo_dir, thanks to @hackebrot (#579, #580)
- Implemented bumpversion, thanks to @hackebrot (#582)
- Added more cookiecutter templates to the mix:
- cookiecutter-octoprint-plugin by @foosel (#560)
- wagtail-cookiecutter-foundation by @chrisdev, et al. (#566)
Zimtsterne are cinnamon star cookies
New Feature:
- Returns rendered project dir, thanks to @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 and @hackebrot (#536, #542).
Other Changes:
- Enable py35 support on Travis by using Python 3.5 as base Python (@maiksensi / #540)
- If a filename is empty, do not generate. Log instead (@iljabauer / #444)
- Fix tests as per last changes in cookiecutter-pypackage, thanks to @eliasdorneles (#555).
- Removed deprecated cookiecutter-pylibrary-minimal from the list, thanks to @ionelmc (#556)
- Moved to using rualmel.yaml instead of PyYAML, except for Windows users on Python 2.7, thanks to @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.
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 feature, making it much easier for developers of Ansible, Salt Stack, and other recipe-based tools to work with Cookiecutter. Thanks to @osantana and @LucianU for their innovation, as well as @hackebrot for fixing the Windows problems (#132, #184, #425).
- Added specify output directory, thanks to @tony and @hackebrot (#531, #452).
- Abort template rendering if the project output directory already exists, thanks to @lgp171188 (#470, #471).
- Add a flag to overwrite existing output directory, thanks to @lgp171188 for the implementation (#495) and @schacki, @ionelmc, @pydanny and @hackebrot for submitting issues and code reviews (#475, #493).
- Remove test command in favor of tox, thanks to @hackebrot (#480).
- Allow cookiecutter invocation, even without installing it, via
python -m cookiecutter.cli
, thanks to @vincentbernat and @hackebrot (#449, #487). - Improve the type detection handler for online and offline repositories, thanks to @charlax (#490).
- Add replay feature, thanks to @hackebrot (#501).
- Be more precise when raising an error for an invalid user config file, thanks to @vaab and @hackebrot (#378, #528).
- Added official Python 3.5 support, thanks to @pydanny and @hackebrot (#522).
- Added support for choice variables and switch to click style prompts, thanks to @hackebrot (#441, #455).
Other Changes:
- Updated click requirement to < 6.0, thanks to @pydanny (#473).
- Added landscape.io flair, thanks to @michaeljoseph (#439).
- Descriptions of PEP8 specifications and milestone management, thanks to @michaeljoseph (#440). * Added alternate installation options in the documentation, thanks to @pydanny (#117, #315).
- The test of the which() function now tests against the date command, thanks to @vincentbernat (#446)
- Ensure file handles in setup.py are closed using with statement, thanks to @svisser (#280).
- Removed deprecated and fully extraneous compat.is_exe() function, thanks to @hackebrot (#485).
- Disabled sudo in .travis, thanks to @hackebrot (#482).
- Switched to shields.io for problematic badges, thanks to @pydanny (#491).
- Added whichcraft and removed
compat.which()
, thanks to @pydanny (#511). - Changed to export tox environment variables to codecov, thanks to @maiksensi. (#508).
- Moved to using click version command, thanks to @hackebrot (#489).
- Don't use unicode_literals to please click, thanks to @vincentbernat (#503).
- Remove warning for Python 2.6 from __init__.py, thanks to @hackebrot.
- Removed compat.py module, thanks to @hackebrot.
- Added future to requirements, thanks to @hackebrot.
- Fixed problem where expanduser does not resolve "~" correctly on windows 10 using tox, thanks to @maiksensi. (#527)
- Added more cookiecutter templates to the mix:
- cookiecutter-beamer by @luismartingil (#307)
- cookiecutter-pytest-plugin by @pytest-dev and @hackebrot (#481)
- cookiecutter-csharp-objc-binding by @SandyChapman (#460)
- cookiecutter-flask-foundation by @JackStouffer (#457)
- cookiecutter-tryton-fulfilio by @fulfilio (#465)
- cookiecutter-tapioca by @vintasoftware (#496)
- cookiecutter-sublime-text-3-plugin by @kkujawinski (#500)
- cookiecutter-muffin by @drgarcia1986 (#494)
- cookiecutter-django-rest by @agconti (#520)
- cookiecutter-es6-boilerplate by @agconti (#521)
- cookiecutter-tampermonkey by @christabor (#516)
- cookiecutter-wagtail by @torchbox (#533)
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 (#322, #332, #334, #336, #337, #338, #340, #341, #343, #345, #347, #351, #412, #413, #414).
- Generate pytest coverage, thanks to @michaeljoseph (#326).
- Documenting of Pull Request merging and HISTORY.rst maintenance, thanks to @michaeljoseph (#330).
- Large expansions to the tutorials thanks to @hackebrot (#384)
- Switch to using Click for command-line options, thanks to @michaeljoseph (#391, #393).
- Added support for working with private repos, thanks to @marctc (#265).
- Wheel configuration thanks to @michaeljoseph (#118).
Other Changes:
- Formally removed support for 2.6, thanks to @pydanny (#201).
- Moved to codecov for continuous integration test coverage and badges, thanks to @michaeljoseph (#71, #369).
- Made JSON parsing errors easier to debug, thanks to @rsyring and @mark0978 (#355, #358, #388).
- Updated to Jinja 2.7 or higher in order to control trailing new lines in templates, thanks to @sfermigier (#356).
- Tweaked flake8 to ignore e731, thanks to @michaeljoseph (#390).
- Fixed failing Windows tests and corrected AppVeyor badge link thanks to @msabramo (#403).
- Added more Cookiecutters to the list:
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 (#319) and @ramiroluz (#310).
- Add PendingDeprecation warning for users of Python 2.6, as support for it is gone in Python 2.7, thanks to @michaeljoseph (#201).
Bug Fixes:
- Corrected typo in Makefile, thanks to @inglesp (#297).
- Raise an exception when users don't have git or hg installed, thanks to @pydanny (#303).
Other changes:
- Creation of gitter account for logged chat, thanks to @michaeljoseph.
- Added ReadTheDocs badge, thanks to @michaeljoseph.
- Added AppVeyor badge, thanks to @pydanny
- Documentation and PyPI trove classifier updates, thanks to @thedrow (#323 and #324)
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, @fcurella, @aventurella, @emonty, @schacki, @ryanolson, @pfmoore, @pydanny, @audreyr (#260).
- Context is now injected into hooks, thanks to @michaeljoseph and @dinopetrone.
- Moved all Python 2/3 compatability code into cookiecutter.compat, making the eventual move to six easier, thanks to @michaeljoseph (#60, #102).
- Added cookiecutterrc defined aliases for cookiecutters, thanks to @pfmoore (#246)
- Added flake8 to tox to check for pep8 violations, thanks to @natim.
Bug Fixes:
- Newlines at the end of files are no longer stripped, thanks to @treyhunner (#183).
- Cloning prompt suppressed by respecting the no_input flag, thanks to @trustrachel (#285)
- With Python 3, input is no longer converted to bytes, thanks to @uranusjr (#98).
Other Changes:
- Added more Cookiecutters to the list:
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.
- Updates 2.6 requirements to include simplejson, thanks to @saxix.
- Avoid unwanted extra spaces in string literal, thanks to @merwok.
- Fix @unittest.skipIf error on Python 2.6.
- Let sphinx parse :param: properly by inserting newlines #213, thanks to @mineo.
- Fixed Windows test prompt failure by replacing stdin per @cjrh in #195.
- Made rmtree remove readonly files, thanks to @pfmoore.
- Now using tox to run tests on Appveyor, thanks to @pfmoore (#241).
- Fixed tests that assumed the system encoding was utf-8, thanks to @pfmoore (#242, #244).
- Added a tox ini file that uses py.test, thanks to @pfmoore (#245).
Other Changes:
- @audreyr formally accepted position as BDFL of cookiecutter.
- Elevated @pydanny, @michaeljoseph, and @pfmoore to core committer status.
- Added Core Committer guide, by @audreyr.
- Generated apidocs from make docs, by @audreyr.
- Added contributing command to the make docs function, by @pydanny.
- Refactored contributing documentation, included adding core committer instructions, by @pydanny and @audreyr.
- Do not convert input prompt to bytes, thanks to @uranusjr (#192).
- Added troubleshooting info about Python 3.3 tests and tox.
- Added documentation about command line arguments, thanks to @saxix.
- Style cleanups.
- Added environment variable to disable network tests for environments without networking, thanks to @vincentbernat.
- Added Appveyor support to aid Windows integrations, thanks to @pydanny (#215).
- CONTRIBUTING.rst is now generated via make contributing, thanks to @pydanny (#220).
- Removed unnecessary endoing argument to json.load, thanks to @pfmoore (#234).
- Now generating shell hooks dynamically for Unix/Windows portability, thanks to @pfmoore (#236).
- Removed non-portable assumptions about directory structure, thanks to @pfmoore (#238).
- Added a note on portability to the hooks documentation, thanks to @pfmoore (#239).
- Replaced unicode_open with direct use of io.open, thanks to @pfmoore (#229).
- Added more Cookiecutters to the list:
Bug fixes:
- Use the current Python interpreter to run Python hooks, thanks to @coderanger.
- Include tests and documentation in source distribution, thanks to @vincentbernat.
- Fix various warnings and missing things in the docs (#129, #130), thanks to @nedbat.
- Add command line option to get version (#89), thanks to @davedash and @cyberj.
Other changes:
- Add more Cookiecutters to the list:
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.
- Support for pre-generate and post-generate hooks, thanks to @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.
- Support for Mercurial version control system, thanks to @pokoli.
- When a cookiecutter contains invalid Jinja2 syntax, you get a better message that shows the location of the TemplateSyntaxError. Thanks to @benjixx.
- Can now prompt the user to enter values during generation from a local cookiecutter, thanks to @ThomasChiroux. This is now always the default behavior. Prompts can also be supressed 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.
- User config in a ~/.cookiecutterrc file, thanks to @raphigaziano. Configurable settings are cookiecutters_dir and default_context.
- File permissions are now preserved during project generation, thanks to @benjixx.
Bug fixes:
- Unicode issues with prompts and answers are fixed, thanks to @s-m-i-t-a.
- The test suite now runs on Windows, which was a major effort. Thanks to @pydanny, who collaborated on this with me.
Other changes:
- Quite a bit of refactoring and API changes.
- Lots of documentation improvements. Thanks @sloria, @alex, @pydanny, @freakboy3742, @es128, @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, @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.
- Now depends on binaryornot 0.2.0.
- Windows support officially added.
- Fix TemplateNotFound Exception on Windows (#37).
- Fix copying of binary files in nested paths (#41), thanks to @sloria.
- 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.
- 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.
- 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.
Friendlier, more simplified command line usage:
# Create project from the cookiecutter-pypackage/ template $ cookiecutter cookiecutter-pypackage/ # Create project from the cookiecutter-pypackage.git repo template $ cookiecutter https://github.com/audreyr/cookiecutter-pypackage.git
Can now use Cookiecutter from Python as a package:
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/audreyr/cookiecutter-pypackage.git')
Internal refactor to remove any code that changes the working directory.
- 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.
- Takes in command line args for the input and output directories.
- Minor cleanup.
Bumped to "Development Status :: 3 - Alpha".
- Works with any type of text file.
- Directory names and filenames can be templated.
- First release on PyPI.
https://github.com/audreyr/cookiecutter/milestones?direction=desc&sort=due_date&state=open