A command-line utility that creates projects from cookiecutters (project templates), e.g. Python package projects, VueJS projects.

Overview

Cookiecutter

pypi python Build Status codecov slack docs Code Qaulity

A command-line utility that creates projects from cookiecutters (project templates), e.g. creating a Python package project from a Python package project template.

Cookiecutter

We are proud to be an open source sponsor of PyCon 2016.

Features

Did someone say features?

  • Cross-platform: Windows, Mac, and Linux are officially supported.
  • You don't have to know/write Python code to use Cookiecutter
  • Works with Python 3.6, 3.7, 3.8, 3.9 and PyPy3.
  • Project templates can be in any programming language or markup format: Python, JavaScript, Ruby, CoffeeScript, RST, Markdown, CSS, HTML, you name it. You can use multiple languages in the same project template.
  • Simple command line usage:
# Create project from the cookiecutter-pypackage.git repo template
# You'll be prompted to enter values.
# Then it'll create your Python package in the current working directory,
# based on those values.
$ cookiecutter https://github.com/audreyr/cookiecutter-pypackage
# For the sake of brevity, repos on GitHub can just use the 'gh' prefix
$ cookiecutter gh:audreyr/cookiecutter-pypackage
  • Use it at the command line with a local template:
# Create project in the current working directory, from the local
# cookiecutter-pypackage/ template
$ cookiecutter cookiecutter-pypackage/
  • Or use it from 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/audreyr/cookiecutter-pypackage.git')
  • Directory names and filenames can be templated. For example:
{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}.py
  • Supports unlimited levels of directory nesting.
  • 100% of templating is done with Jinja2. This includes file and directory names.
  • Simply define your template variables in a cookiecutter.json file. For example:
{
    "full_name": "Audrey Roy",
    "email": "[email protected]",
    "project_name": "Complexity",
    "repo_name": "complexity",
    "project_short_description": "Refreshingly simple static site generator.",
    "release_date": "2013-07-10",
    "year": "2013",
    "version": "0.1.1"
}
  • Unless you suppress it with --no-input, you are prompted for input:
    • Prompts are the keys in cookiecutter.json.
    • Default responses are the values in cookiecutter.json.
    • Prompts are shown in order.
  • Cross-platform support for ~/.cookiecutterrc files:
default_context:
    full_name: "Audrey Roy"
    email: "[email protected]"
    github_username: "audreyr"
cookiecutters_dir: "~/.cookiecutters/"
  • Cookiecutters (cloned Cookiecutter project templates) are put into ~/.cookiecutters/ by default, or cookiecutters_dir if specified.
  • If you have already cloned a cookiecutter into ~/.cookiecutters/, you can reference it by directory name:
# Clone cookiecutter-pypackage
$ cookiecutter gh:audreyr/cookiecutter-pypackage
# Now you can use the already cloned cookiecutter by name
$ cookiecutter cookiecutter-pypackage
  • You can use local cookiecutters, or remote cookiecutters directly from Git repos or from Mercurial repos on Bitbucket.
  • Default context: specify key/value pairs that you want used as defaults whenever you generate a project.
  • Inject extra context with command-line arguments:
cookiecutter --no-input gh:msabramo/cookiecutter-supervisor program_name=foobar startsecs=10
  • Direct access to the Cookiecutter API allows for injection of extra context.
  • Pre- and post-generate hooks: Python or shell scripts to run before or after generating a project.
  • Paths to local projects can be specified as absolute or relative.
  • Projects generated to your current directory or to target directory if specified with -o option.

Available Cookiecutters

Making great cookies takes a lot of cookiecutters and contributors. We're so pleased that there are many Cookiecutter project templates to choose from. We hope you find a cookiecutter that is just right for your needs.

A Pantry Full of Cookiecutters

The best place to start searching for specific and ready to use cookiecutter template is Github search. Just type cookiecutter and you will discover over 4000 related repositories.

We also recommend you to check related GitHub topics. For general search use cookiecutter-template. For specific topics try to use cookiecutter-yourtopic, like cookiecutter-python or cookiecutter-datascience. This is a new GitHub feature, so not all active repositories use it at the moment.

If you are template developer please add related topics with cookiecutter prefix to you repository. We believe it will make it more discoverable. You are almost not limited in topics amount, use it!

Cookiecutter Specials

These Cookiecutters are maintained by the cookiecutter team:

Community

The core committer team can be found in authors section. We are always welcome and invite you to participate.

Stuck? Try one of the following:

  • See the Troubleshooting page.
  • Ask for help on Stack Overflow.
  • You are strongly encouraged to file an issue about the problem, even if it's just "I can't get it to work on this cookiecutter" with a link to your cookiecutter. Don't worry about naming/pinpointing the issue properly.
  • Ask for help on Slack if you must (but please try one of the other options first, so that others can benefit from the discussion).

Development on Cookiecutter is community-driven:

  • Huge thanks to all the contributors who have pitched in to help make Cookiecutter an even better tool.
  • Everyone is invited to contribute. Read the contributing instructions, then get started.
  • Connect with other Cookiecutter contributors and users on Slack (note: due to work and commitments, a core committer might not always be available)

Encouragement is unbelievably motivating. If you want more work done on Cookiecutter, show support:

Got criticism or complaints?

  • File an issue so that Cookiecutter can be improved. Be friendly and constructive about what could be better. Make detailed suggestions.
  • Keep us in the loop so that we can help. For example, if you are discussing problems with Cookiecutter on a mailing list, file an issue where you link to the discussion thread and/or cc at least 1 core committer on the email.
  • Be encouraging. A comment like "This function ought to be rewritten like this" is much more likely to result in action than a comment like "Eww, look how bad this function is."

Waiting for a response to an issue/question?

  • Be patient and persistent. All issues are on the core committer team's radar and will be considered thoughtfully, but we have a lot of issues to work through. If urgent, it's fine to ping a core committer in the issue with a reminder.
  • Ask others to comment, discuss, review, etc.
  • Search the Cookiecutter repo for issues related to yours.
  • Need a fix/feature/release/help urgently, and can't wait? @audreyr is available for hire for consultation or custom development.

Support This Project

This project is run by volunteers. Shortly we will be providing means for organizations and individuals to support the project.

Code of Conduct

Everyone interacting in the Cookiecutter project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the PyPA Code of Conduct.

Comments
  • Feature/local extensions

    Feature/local extensions

    this is a proposed change to add a "_local_extensions" feature. It will enable the use of an additional "_local_extensions" element in the cookiecutter.json file. This will have the exact same functionality as the "_extensions" element, except that it can be used to load jinja2 template extensions straight from the project template.

    I'm not certain if this is the best approach to achieve this, but I'm happy to have some feedback, of course.

    {
        "directory_name": "directory_name",
        "module_name": "module_name",
        "_local_extensions": ["local_extensions.SomeExtension"]
    }
    
    enhancement high-priority feature 
    opened by mwesterhof 51
  • Add support for symlinks

    Add support for symlinks

    ~~This is in place of PR #868, which also include fixes for Windows that seem too messy to be worth pulling in to maintain.~~

    ~~Caveat: Symlinks will not work as expected on Windows with Python versions < 3.2 (but, they don't now anyway...)~~

    Updated PR to support symlinks in templates across platforms now that we don't support older versions of Python.

    feature 
    opened by pjbull 46
  • Stop project generation if pre hook script fails

    Stop project generation if pre hook script fails

    Hey folks,

    Would this be an adequate solution to address issue #464 ?

    My use case is handling an invalid package name (see https://github.com/audreyr/cookiecutter-pypackage/issues/6)

    This proposal will stop the project generation if the pre hook script returns with an exit status different from 0 (indicating success).

    With this proposal, we'd be able to handle that case with a pre_gen_project hook script like:

    import re, sys
    
    PACKAGE_REGEX = r'^[_a-zA-Z][_a-zA-Z0-9]+$'
    
    repo_name = '{{ cookiecutter.repo_name }}'
    if not re.match(PACKAGE_REGEX, repo_name):
        print('ERROR: %s is not a valid package name!' % repo_name)
        sys.exit(1)
    

    Thoughts?

    enhancement needs-docs needs-review 
    opened by eliasdorneles 31
  • How to update a project with changes from its cookiecutter?

    How to update a project with changes from its cookiecutter?

    Hi,

    I maintain several personal cookiecutters, and I found that I spend a lot of time keeping projects in sync with updates on the cookiecutter.

    I started trying a workflow to deal with this, as follows:

    1. Every project I render is assumed to be versioned by git. In the project repo, there is a branch template, that contains the result of cookiecutter rendering, without any other changes.
    2. Every cookiecutter renders a file .cookiecutter.json at the root of the project containing the original context used to render that project, in json format.
    3. Every project has a Makefile containing at least an update-template target. This make target does the following:
      • Create a temporary checkout (via git worktree) of the template branch.
      • Use the stored context in .cookiecutter.json to regenerate the project on top of the temporary checkout, overriding previous content.
      • Commit the newly rendered project in the template branch.

    This way, the template branch tracks the changes from the cookiecutter, and I can use git-merges into master to update the current project.

    The key thing is that by using git merges, I can update template files that got havily modified in the project. Most of the time the merge is clean, but from time to time a conflict will arise, which is easily resolved.

    I've used it for a while and works pretty well. There are at least a couple of pain points though, that could benefit from changes in cookiecutter upstream, which may be of independent interest.

    1. The template I use to generate a .cookiecutter.json is a bit hacky. I'd like to do something like this:

      {{ cookiecutter | jsonify }}
      

      Would you accept distributing this jsonify as a default extension? I can provide the code in an other PR.

    2. In order to get updates from the cookiecutter, the project stores its url in a _template field on its context. Right now, I hard-code this url in the cookiecutter itself. I would love to free my cookiecutters from hard-coding their url, That could be achieved if cookiecutter itself would inject a _template field into the context with the url used at the time of rendering. I submitted #774 to that effect.

    Additionally, maybe a functionality like the update-template I described above could be moved into cookiecutter upstream. That would require some thinking, I guess...

    Of course, any suggestions, or other ways in which a workflow like this could be better supported by cookiecutter would be very welcome!

    enhancement discussion 
    opened by aroig 30
  • Help maintaining Cookiecutter?

    Help maintaining Cookiecutter?

    It's been 5 months without any update. Is there any way we can help with the repo maintenance? There's this issue from 2014, #190, asking for maintainers, maybe is a good starting point to define some commiter criteria?

    discussion 
    opened by maxrodrigo 26
  • 2.0.1 and 2.0.2 are not available on PyPI

    2.0.1 and 2.0.2 are not available on PyPI

    I am confused about the available releases of Cookiecutter. The last version available PyPI is 1.7.3 but I see commits, tags, and a changelog for version 2.0.1 and 2.0.2, and also no 2.0.0 tag or commit.

    Are these tags meant to be pre-releases?

    opened by SylvainCorlay 25
  • 2.0.1 πŸš€

    2.0.1 πŸš€

    Hey @cookiecutter πŸ‘‹ , I think we should start to talks about 2.0.1.

    We have more than a year of unreleased contributions with some breaking changes (python 2, pyyaml, etc) so the next release will be a major πŸŽ‰ and will be huge!

    Let's start with sweet things...

    Changes

    Breaking Changes

    • 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
    • allow jinja 3.0.0 (#1548) @wouterdb

    Minor Changes

    • Log the error message when git clone fails, not just the return code (#1505) @logworthy
    • Added uuid extension to be able to generate uuids (#1493) @jonaswre
    • Alert user if choice is invalid (#1496) @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
    • 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

    • 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

    • 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

    This release is made by wonderful contributors:

    @Cadair, @Casyfill, @Cy-dev-tex, @HosamAlmoghraby, @SharpEdgeMarshall, @agateau, @brettcannon, @chrisbrake, @dHannasch, @gliptak, @glumia, @graue70, @grrlic, @insspb, @javiersanp, @jonaswre, @juhuebner, @logworthy, @lyz-code, @milonimrod, @ndclt, @noirbizarre, @noone234, @oncleben31, @rgreinho, @sebix, @smoothml, @ssbarnea, @steltenpower, @wouterdb, @xyb, Christopher Wolfe and Hosam Almoghraby ( RIAG Digital )

    Thank you all for the amazing work πŸ™ !

    The plan

    There are 4 important breaking changes and tons of features, so I think we should take some extra care to tag this version:

    1. reduce the scope of 2.0.0: at the time of writing, we have 43 open issue/pull request, I have just created the milestone Next as a container for all contributions that are already in the plan but are not essential for this release.
    2. check the documentation and consider a migration guide, also can be a good chance to introduces the use of
    3. consider a release candidate of 2.0.0 to help maintainers to install and test a package instead of a master checkout.
    4. priority and all focus are on releasing 2.0.0 and closing bugs. we already released 1.7.3 (Thanks @ssbarnea πŸ™ ) as a backport of a bugfix for dependencies, and no other intermediate tag (other than security patch and critical bugs) will be released.

    What do you think about it?

    Any contribution will be appreciated, thanks πŸš€ !

    major 
    opened by simobasso 25
  • Added command line option to keep trailing newlines

    Added command line option to keep trailing newlines

    This adds the command line options '--keep-trailing-newline' (or '-n').

    I'm not sure whether 'n' is the right letter to shorten it to and might require some thought.

    I added a newline to one of the test samples. I'm not sure whether that would be okay, or whether it would be better to add a new file to check this with.

    duplicate 
    opened by ghost 23
  • WIP - Hooks enhancement: running real file in place + context serialization

    WIP - Hooks enhancement: running real file in place + context serialization

    hi, here is an enhancement of how hooks work. They now receive through the standard input stream, the cookiecutter context object, serialized in JSON . This allows to unserialize this object, and then simply read and/or update some values that can be sent back to the main context, by writing a JSON serialized object to the standard output.

    It is also possible to disable the hook duplication by adding the setting "_no_hookcopy": "yes" in the cookiecutter.json. Hooks are then run directly in place. This should be useful, when a template author does not need to use template variables directly in his/her hooks and want to keep track of the template directory. A concrete example is license management. In the documentation - Choice Variables (1.1+) - it is explained how to manage licenses in one file. It should be easier to get many license file templates in a directory, and then just copy the selected one. More information and examples are available in the updated Advanced usage page of the documentation of this PR. This is the start of a proposition and I'm very interesting by getting some feedbacks.

    Best regards

    Eric

    enhancement 
    opened by eviweb 22
  • This allows specifying context as arguments

    This allows specifying context as arguments

    Allows specifying or overriding variables by adding key=value arguments after the template.

    E.g.:

    [[email protected] test-cookiecutter-supervisor]$ cookiecutter --no-input https://github.com/msabramo/cookiecutter-supervisor.git program_name=foobar
    Cloning into 'cookiecutter-supervisor'...
    remote: Counting objects: 16, done.
    remote: Compressing objects: 100% (13/13), done.
    remote: Total 16 (delta 5), reused 8 (delta 2), pack-reused 0
    Unpacking objects: 100% (16/16), done.
    Checking connectivity... done.
    
    [[email protected] test-cookiecutter-supervisor]$ cat foobar/supervisor.conf
    [program:foobar]
    numprocs                 = 1
    process_name             = %(program_name)s%(process_num)02d
    user                     = foobaruser
    command                  = gunicorn --bind 0.0.0.0:$PORT --paste development.ini
    startsecs                = 30
    priority                 = 12
    redirect_stderr          = true
    autorestart              = true
    autostart                = true
    stopwaitsecs             = 10
    stopsignal               = QUIT
    directory                = /opt/webapp/foobar
    stdout_logfile           = /var/log/sm/foobar-app-out.log
    stdout_logfile_maxbytes  = 10MB
    stdout_logfile_backups   = 0
    stdout_capture_maxbytes  = 1MB
    stderr_logfile           = /var/log/sm/foobar-app-err.log
    stderr_logfile_maxbytes  = 10MB
    stderr_logfile_backups   = 0
    stderr_capture_maxbytes  = 1MB
    environment              = NEW_RELIC_CONFIG_FILE="/opt/webapp/foobar/etc/newrelic.ini"
    
    enhancement 
    opened by msabramo 21
  • Support a new YAML format for template settings

    Support a new YAML format for template settings

    This is the initial version of support for a YAML format settings file, to supersede cookiecutter.json. Before committing, I would like to refactor this further, to make the "internal" format completely encapsulated in settings.py so that client code need have no knowledge of how the settings are stored. But the PR is sufficiently complete that it's ready for initial review.

    At the moment, it's only the context data that is in the settings, so the refactoring won't actually impact much, but it establishes the principle that following changes should follow. The main change at this stage will be in the tests, which currently know far too much about how the settings/context is stored.

    opened by pfmoore 21
  • Fixing Carriage Return Line Feed (CRLF) order in docs #1792

    Fixing Carriage Return Line Feed (CRLF) order in docs #1792

    In the "Working with line-ends special symbols LF/CRLF" section of the documentation we can see:

    The special template variable _new_lines enforces a specific line ending. Acceptable variables: '\n\r' for CRLF and '\n' for POSIX.

    Here is example how to force line endings to CRLF on any deployment:

    {
        "project_slug": "sample",
        "_new_lines": "\n\r"
    }
    

    But this order is mistaken, since:

    "The traditional order, when both control characters are used, is Carriage Return, then Line Feed.

    The reason for this goes back to the old ASR-33 Teletype.

    When a Carriage Return is issued to an ASR-33, the print head, if it is near the right margin, takes over a tenth of a second to return to the left margin, plus there is a bit of "bounce" when the left margin is hit.

    If the order were Line Feed, then Carriage Return, the first printed character might occur a tenth of a second after the Carriage Return, and thus might end up printing (as a smear) halfway across the page. But if Line Feed comes after Carriage Return then the time taken by the Line Feed provides extra time for the print head to complete it's trip."

    StackOverflow

    So this PR aims at fixing the CRLF order to the traditional '\r\n'

    opened by Lahiry 0
  • Working with line-ends: Inverted attributes

    Working with line-ends: Inverted attributes

    • Cookiecutter version: 2.1.1
    • Template project url:
    • Python version: 3.9.13
    • Operating System: Windows 10

    Description:

    In the documentation (link below) there is a code sample with "\n\r", but I think it is the opposite :) For me it works with "\r\n". \r represents cr \n represents lf

    docs/advanced/new_line_characters.rst

    opened by Ikari33 1
  • YAML config is translated from string to python bool in string presentation

    YAML config is translated from string to python bool in string presentation

    • Cookiecutter version: 1.7.3 vs 2.1.1
    • Template project url: https://github.com/meckhardt/cookiecutter-testcase
    • Python version: 3.9 (and others)
    • Operating System: Amazon Linux, Mac OSX (M1), Debian

    Description:

    When using a config yaml to overwrite defaults in cookiecutter.json the result is unexpected and also behaves different. As there will be upcoming changes for boolean handling in 2.2, this issue might be even more interesting.

    For instance:

    The cookiecutter.json

    {
      "name": "uiui",
      "var_yes": "yes",
      "var_no": "no"
    }
    

    Without overwriting the values via a config yaml, the results in a generated file are:

    # generated.yml with cookiecutter 2.1.1
    ---
    var_yes: yes
    var_no: no
    
    # generated.yml with cookiecutter 1.7.3
    ---
    var_yes: yes
    var_no: no
    

    With overwriting the values via a config yaml, the results in a generated file are:

    # generated.yml with cookiecutter 2.1.1
    ---
    var_yes: True
    var_no: False
    
    # generated.yml with cookiecutter 1.7.3
    ---
    var_yes: yes
    var_no: no
    

    I expected to have yes instead of True and no instead of False. This is the case when using the cookiecutter 1.7.3 release. Since upgrading to 2.1.1 this behavior changed.

    What I've run:

    You can use the github workflow of the project https://github.com/meckhardt/cookiecutter-testcase to see the different results for cookiecutter 1.7.3 and 2.1.1.

    Cookiecutter 1.7.3: grafik

    Cookiecutter 2.1.1: grafik

    opened by meckhardt 0
  • insert/update a single line in a file

    insert/update a single line in a file

    • Cookiecutter version: latest
    • Template project url: tutorial project
    • Python version: 3.8
    • Operating System: mac

    Description:

    Is it possible to update an existing file with this tool? i.e. i have a non cookiecutter regular project in github, I clone it and I want to insert {{project.slug}} at line x in the a file i.e. I dont want to replace but insert this line

    opened by bytearchive 0
Releases(2.1.1)
  • 2.1.1(Jun 1, 2022)

    Documentation updates

    • Fix local extensions documentation (#1686) @alkatar21

    Bugfixes

    • Sanitize Mercurial branch information before checkout. (#1689) @ericof

    This release is made by wonderful contributors:

    @alkatar21, @ericof and @jensens

    Source code(tar.gz)
    Source code(zip)
  • 2.1.0(May 30, 2022)

    Preamble

    This release log lists all changes from 1.7.3 to this release. It includes the log of the 2.0.x releases, which were never published on PyPI. Because of that it might look a bit blurry.

    We release the current stable state of the project, knowing there are a bunch of open pull requests. Those will be reviewed by the core-committers and merged or dropped.

    Future releases will happen more frequently. Stay tuned.

    Fetch fresh from PyPI https://pypi.org/project/cookiecutter/2.1.0/

    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
    • Release 2.0.1 (#1620) @audreyfeldroy

    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

    • Documentation overhaul (#1677) @jensens
    • Feature/local extensions (#1240) @mwesterhof
    • 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

    • Check manifest: pre-commit, fixes, cleaning (#1683) @jensens
    • Follow PyPA guide to release package using GitHub Actions. (#1682) @ericof
    • 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 typo in dict_variables.rst (#1680) @ericof
    • Documentation overhaul (#1677) @jensens
    • Fixed incorrect link on docs. (#1649) @luzfcb
    • 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) @cxnstantius
    • 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

    • Restore accidentally deleted support for click 8.x (#1643) @jaklan
    • Fix Python version number in cookiecutter --version and test on Python 3.10 (#1621) @ozer550
    • 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

    This release is made by wonderfull contributors:

    @Cadair, @Casyfill, @Cy-dev-tex, @HosamAlmoghraby, @MaciejPatro, @SharpEdgeMarshall, @agateau, @audreyfeldroy, @brettcannon, @browniebroke, @chrisbrake, @cjolowicz, @cxnstantius, @dHannasch, @doobrie, @ericof, @gliptak, @glumia, @graue70, @insspb, @jaklan, @javiersanp, @jensens, @jonaswre, @jsoref, @juhuebner, @logworthy, @luzfcb, @lyz-code, @michaeljoseph, @milonimrod, @mwesterhof, @ndclt, @noirbizarre, @noone234, @oncleben31, @ozer550, @pydanny, @rgreinho, @sebix, @simobasso, @smoothml, @ssbarnea, @steltenpower, @wouterdb, @xyb, Christopher Wolfe and Hosam Almoghraby ( RIAG Digital )

    Source code(tar.gz)
    Source code(zip)
  • 1.7.3(May 14, 2021)

  • 1.7.2(Apr 21, 2020)

  • 1.7.1(Apr 20, 2020)

    1.7.1 (2019-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 (#1357)
    • Multiple templates per one repository feature added. @RomHartmann (#1224, #1063)
    • Update replay.py json.dump indent for easy viewing @nicain (#1293)
    • 'future' library replaced with 'six' as a more lightweight python porting library @asottile (#941)
    • Added extension: Slugify template filter @ppanero (#1336)
    • Added command line option: --skip-if-file-exists, allow to skip the existing files when doing overwrite_if_exists. @chhsiao1981 (#1076)
    • Some packages versions limited to be compatible with python2.7 and python 3.5 @insspb (#1349)

    Internal CI/CD and tests changes:

    • Coverage comment in future merge requests disabled @ssbarnea (#1279)
    • Fixed Python 3.8 travis tests and setup.py message @insspb (#1295, #1297)
    • Travis builds extended with Windows setup for all supported python versions @insspb (#1300, #1301)
    • Update .travis.yml to be compatible with latest travis cfg specs @luzfcb (#1346)
    • Added new test to improve tests coverage @amey589 (#1023)
    • Added missed coverage lines highlight to pytest-coverage report @insspb (#1352)
    • pytest-catchlog package removed from test_requirements, as now it is included in pytest @insspb (#1347)
    • Fixed cov-report tox invocation environment @insspb (#1350)
    • Added: Release drafter support and configuration to exclude changelog update work and focus on development @ssbarnea @insspb (#1356, #1362)
    • Added: CI/CD steps for Github actions to speedup CI/CD @insspb (#1360)
    • Removed: Appveyor CI/CD completely removed @insspb @ssbarnea @insspb (#1363, #1367)

    Code style and docs changes:

    • Added black formatting verification on lint stage + project files reformatting @ssbarnea @insspb (#1368)
    • Added pep257 docstring for tests/* files @insspb (#1369, #1370, #1371, #1372, #1373, #1374, #1375, #1376, #1377, #1378, #1380, #1381)
    • Added pep257 docstring for tests/conftests.py @kishan (#1272, #1263)
    • Added pep257 docstring for tests/replay/conftest.py @kishan (#1270, #1268)
    • Added pep257 docstring for docs/init.py @kishan (#1273, #1265)
    • Added missing docstring headers to all files @croesnick (#1269, #1283)
    • Gitter links replaced by Slack in README @browniebroke (#1282)
    • flake8-docstrings tests added to CI/CD @ssbarnea (#1284)
    • Activated pydocstyle rule: D401 - First line should be in imperative mood @ssbarnea (#1285)
    • Activated pydocstyle rule: D200 - One-line docstring should fit on one line with quotes @ssbarnea (#1288)
    • Activated pydocstyle rule: D202 - No blank lines allowed after function docstring @ssbarnea (#1288)
    • Activated pydocstyle rule: D205 - 1 blank line required between summary line and description @ssbarnea (#1286, #1287)
    • Activated pydocstyle rule: ABS101 @ssbarnea (#1288)
    • Replaced click documentation links to point to version 7 @igorbasko01 (#1303)
    • Updated submodule link to latest version with documentation links fix @DanBoothDev (#1388)
    • Fixed links in main README file. @insspb (#1342)
    • Fix indentation of .cookiecutterrc in README.md @mhsekhavat (#1322)
    • Changed format of loggers invocation @insspb (#1307)
    Source code(tar.gz)
    Source code(zip)
  • 1.7.0(Dec 22, 2019)

    Important changes

    • Drop support for EOL Python 3.3, 3.4, thanks to @hugovk, @jamescurtin and @insspb (#1024)
    • Prevent click API 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, and cookiecutter/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)
    • 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 TOXENV environment variable, thanks to @asottile (#1019)

    Templates list modification

    Source code(tar.gz)
    Source code(zip)
  • 1.6.0(Oct 15, 2017)

    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 git operation failures, thanks to @jmcarp (#905)

    Other Changes

    Source code(tar.gz)
    Source code(zip)
  • 1.5.1(Feb 4, 2017)

    Hotfix release to address an issue with dict variables.

    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

    Source code(tar.gz)
    Source code(zip)
  • 1.5.0(Dec 18, 2016)

    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 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 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 and post_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 in prompt.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 and post_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 @TAMU-CPT (#832)
    Source code(tar.gz)
    Source code(zip)
  • 1.4.0(Mar 20, 2016)

    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 and replay_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() and replay.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 with utf-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:

    Source code(tar.gz)
    Source code(zip)
  • 1.3.0(Nov 10, 2015)

    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 (#464, #549)
    • Extend user config capabilities with additional cli options --config-file and --default-config and environment variable COOKIECUTTER_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)
    Source code(tar.gz)
    Source code(zip)
  • 1.2.1(Oct 18, 2015)

    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, thanks to @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.

    Source code(tar.gz)
    Source code(zip)
  • 1.1.0(Sep 26, 2015)

    The primary goal of this release was to add 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).

    Other Changes:

    https://en.wikipedia.org/wiki/Snickerdoodle

    Source code(tar.gz)
    Source code(zip)
  • 1.0.0(Mar 16, 2015)

    The goals of this release were 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:
      • cookiecutter-scala-spark by @jpzk
      • cookiecutter-atari2600 by @joeyjoejoejr
      • cookiecutter-bottle by @avelino
      • cookiecutter-latex-article by @Kreger51
      • cookiecutter-django-rest-framework by @jpadilla
      • cookiedozer by @hackebrot
    Source code(tar.gz)
    Source code(zip)
  • 0.9.1(Jan 20, 2015)

  • 0.9.0(Jan 15, 2015)

    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)
    Source code(tar.gz)
    Source code(zip)
  • 0.8.0(Nov 2, 2014)

    The goal of this release (Cookiecutter 0.8.0 on PyPI) was to allow for injection of extra context via the Cookiecutter API, and to continue fixing 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

    Added more Cookiecutters to the list:

    • Python-iOS-template by @freakboy3742
    • Python-Android-template by @freakboy3742
    • cookiecutter-djangocms-plugin by @mishbahr
    • cookiecutter-pyvanguard by @robinandeer
    Source code(tar.gz)
    Source code(zip)
  • 0.7.2(Aug 6, 2014)

    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:
      • cookiecutter-kivy by @hackebrot
      • BoilerplatePP by @Paspartout
      • cookiecutter-pypackage-minimal by @borntyping
      • cookiecutter-ansible-role by @iknite
      • cookiecutter-pylibrary by @ionelmc
      • cookiecutter-pylibrary-minimal by @ionelmc
    Source code(tar.gz)
    Source code(zip)
  • 0.7.1(Apr 26, 2014)

    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:
      • cookiecutter-avr by @solarnz
      • cookiecutter-tumblr-theme by @relekang
      • cookiecutter-django-paas by @pbacterio
    Source code(tar.gz)
    Source code(zip)
  • 0.7.0(Nov 12, 2013)

    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.
    Source code(tar.gz)
    Source code(zip)
Owner
null
Shared utility scripts for AI for Earth projects and team members

Overview Shared utilities developed by the Microsoft AI for Earth team The general convention in this repo is that users who want to consume these uti

Microsoft 36 Aug 28, 2022
A python tool that creates issues in your repos based on TODO comments in your code

Krypto A neat little sidekick python script to create issues on your repo based on comments left in the code on your behalf Convert todo comments in y

Alex Antoniou 4 Oct 26, 2021
πŸ€–πŸ§­Creates google-like navigation menu using python-telegram-bot wrapper

python telegram bot menu pagination Makes a google style pagination line for a list of items. In other words it builds a menu for navigation if you ha

Sergey Smirnov 8 Nov 10, 2022
Render your templates using .txt files

PizzaX About Run Run tests To run the tests, open your terminal and type python tests.py (WIN) or python3 tests.py (UNX) Using the function To use the

Marcello Belanda 2 Nov 24, 2021
easy_sbatch - Batch submitting Slurm jobs with script templates

easy_sbatch - Batch submitting Slurm jobs with script templates

Wei Shen 13 Oct 11, 2022
A tool to quickly create codeforces contest directories with templates.

Codeforces Template Tool I created this tool to help me quickly set up codeforces contests/singular problems with templates. Tested for windows, shoul

null 1 Jun 2, 2022
Easy to use phishing tool with 65 website templates. Author is not responsible for any misuse.

PyPhisher [+] Description : Ultimate phishing tool in python. Includes popular websites like facebook, twitter, instagram, github, reddit, gmail and m

KasRoudra 876 Nov 15, 2022
Calculator in command line using python programming language

Calculator in command line using python programming language University of the People Python fundamental Chapter 5 Conditionals and recursion The main

mark sikaundi 3 Dec 9, 2021
GitHub Actions Version Updater Updates All GitHub Action Versions in a Repository and Creates a Pull Request with the Changes.

GitHub Actions Version Updater GitHub Actions Version Updater is GitHub Action that is used to update other GitHub Actions in a Repository and create

Maksudul Haque 40 Nov 22, 2022
A tool that automatically creates fuzzing harnesses based on a library

AutoHarness is a tool that automatically generates fuzzing harnesses for you. This idea stems from a concurrent problem in fuzzing codebases today: large codebases have thousands of functions and pieces of code that can be embedded fairly deep into the library. It is very hard or sometimes even impossible for smart fuzzers to reach that codepath. Even for large fuzzing projects such as oss-fuzz, there are still parts of the codebase that are not covered in fuzzing. Hence, this program tries to alleviate this problem in some capacity as well as provide a tool that security researchers can use to initially test a code base. This program only supports code bases which are coded in C and C++.

null 260 Oct 26, 2022
creates a batch file that uses adb to auto-install apks into the Windows Subsystem for Android and registers it as the default application to open apks.

wsa-apktool creates a batch file that uses adb to auto-install apks into the Windows Subsystem for Android and registers it as the default application

Aditya Vikram 3 Apr 5, 2022
A simple program which gets a file(CSV/Excel) with tasks and creates different variants

TestMakerProject A simple program which gets a file(CSV/Excel) with tasks and creates different variants The main program is QTengine.py You only have

George 3 Nov 18, 2021
Addon for Blender 2.8+ that automatically creates NLA tracks for all animations. Useful for GLTF export.

PushDownAll An addon for Blender 2.8+ that runs Push Down on all animations, creating NLA tracks for each. This is useful if you have an object with m

Cory Petkovsek 16 Oct 6, 2022
Script that creates graphical representations of Julia an Mandelbrot sets.

Julia and Mandelbrot Picture Maker This simple functions create simple plots of the Julia and Mandelbrot sets. The Julia set require the important par

Juan Riera Gomez 1 Jan 10, 2022
Creates a release pull request updating changelog and tags with standard-version

standard version release branch Github action to open releases following convent

null 8 Sep 13, 2022
Arcpy Tool developed for ArcMap 10.x that checks DVOF points against TDS data and creates an output feature class as well as a check database.

DVOF_check_tool Arcpy Tool developed for ArcMap 10.x that checks DVOF points against TDS data and creates an output feature class as well as a check d

null 3 Apr 18, 2022
Adansons Base is a data management tool that organizes metadata of unstructured data and creates and organizes datasets.

Adansons Base is a data management tool that organizes metadata of unstructured data and creates and organizes datasets. It makes dataset creation more effective and helps find essential insights from training results and improves AI performance.

Adansons Inc 27 Oct 22, 2022
This module extends twarc to allow you to print out tweets as text for easy testing on the command line

twarc-text This module extends twarc to allow you to print out tweets as text for easy testing on the command line. Maybe it's useful for spot checkin

Documenting the Now 2 Oct 12, 2021
A command line interface tool converting starknet warp transpiled outputs into readable cairo contracts.

warp-to-cairo warp-to-cairo is a simple tool converting starknet warp outputs (NethermindEth/warp) outputs into readable cairo contracts. The warp out

Michael K 5 Jun 10, 2022