<commit_before>.. :changelog:

History
-------

1.5.0 (2016-04-20) ???
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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 for ``DEBUG`` 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`_ (#815).

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)

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)
* 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)<commit_msg>Update HISTORY.rst with #678<commit_after>.. :changelog:

History
-------

1.5.0 (2016-04-20) ???
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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 for ``DEBUG`` 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`_ (#815).

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)

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 in ``prompt.py``, thanks to
  `@pydanny`_ (#678)
* 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)
{'fraction_non_alphanumeric': 0.13077203869319218, 'fraction_numerical': 0.04051834276327797, 'mean_word_length': 4.911003236245954, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 5, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4384509', 'n_tokens_mistral': 4144, 'n_tokens_neox': 3651, 'n_words': 1385}