Skip to main content

upgrade projects created from a Cookiecutter template

Project description

Cookiecutter Project Upgrader CI Status - master Documentation Status Code Coverage

Upgrade projects created from a Cookiecutter template.


Cookiecutter Project Upgrader allows upgrading projects that were created using Cookiecutter.

After a project has been created from a Cookiecutter template, changes made to the Cookiecutter template usually have to be applied manually to the project. This tool automates this process.

When run the first time on a project, it creates a new branch from the first commit of the current branch (the oldest one). It then generates the project again using the latest version of the template and creates a new commit that contains the latest cookiecuttered code,

Usage: cookiecutter_project_upgrader [OPTIONS]

Upgrade projects created from a Cookiecutter template
-c, --context-file PATH
 Default: docs/cookiecutter_input.json
-b, --branch TEXT
 Default: cookiecutter-template
-u, --upgrade-branch TEXT
 Optional branch name of cookiecutter template to checkout before upgrading.
-f, --zip-file TEXT
 Zip file Path/URL for Cookiecutter templates.
-i, --interactive
 Enter interactive mode. Default behaviour: skip questions, use defaults.
-m, --merge-now BOOLEAN
 Execute a git merge after a successful update, default: ask if interactive, otherwise false.
-p, --push-template-branch-changes BOOLEAN
 Push changes to the remote Git branch on a successful update, default: ask if interactive, otherwise false.
-e, --exclude TEXT
 Git pathspecs to exclude from the update commit, e.g. -e “*.py” -e “tests/”.
-h, --help Show this message and exit.


The tool requires a JSON file with context that matches the existing service. This file can be created through Cookiecutter with the following contents:

{{ cookiecutter | jsonify }}

You will need a recent version of git for this to work. (it needs –no-checkout on git worktree)


The script uses the Click toolkit. Because the script uses Click, you can enable completion for Zsh and Bash.

For Bash, add the following to your .bashrc or some other profile initialization file. eval “$(_COOKIECUTTER_PROJECT_UPGRADER_COMPLETE=source cookiecutter_project_upgrader)”

For Zsh, please read the Click documentation.


The concept and some code is heavily based on, with some changes to use Click and some flags and default values to ease usage. Also cleanup has been done and automated tests have been added.

This package was created with Cookiecutter and the thomasjahoda/cookiecutter-pypackage project template.


1.0.0 (2019-03-22)

  • First release on PyPI.

1.1.0 (2019-03-24)

  • Ask for some options interactively if within interactive shell.

1.2.0 (2020-08-02)

  • Move interactive mode behind -i flag.
  • Add -p flag to push the branch on successful update.
  • Add -e flag to exclude git pathspecs from the update.
  • Do not run pre-commit hooks on the update commit.
  • Expose -h flag in addition to –help.
  • Finish with non-zero exit status if there are no changes to be made (for shell piping).

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cookiecutter_project_upgrader-1.3.1.tar.gz (25.2 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page