A cross-platform command-line utility that creates projects from cookiecutters (project templates), e.g. Python package projects, C projects - a cookiecutter fork
A command-line utility that creates projects from cookiecutters (project templates), e.g. creating a Python package project from a Python package project template.
We have decided to fork the original cookiecutter project because the project is on hiatus and the maintainers aren't
working on it anymore. We strive to bring the life back to the project. We would like the community to contribute to this fork,
to make it as good as possible!
pip install cookieninja
Simple command line usage:
# Create project from the cookieninja-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.
$ cookieninja https://github.com/audreyfeldroy/cookiecutter-pypackage
# For the sake of brevity, repos on GitHub can just use the 'gh' prefix
$ cookieninja gh:audreyfeldroy/cookiecutter-pypackage
Use it at the command line with a local template:
# Create project in the current working directory, from the local
# cookieninja-pypackage/ template
$ cookieninja cookieninja-pypackage/
Or use it from Python:
from cookieninja.main import cookiecutter
# Create project from the cookieninja-pypackage/ template
cookiecutter('cookieninja-pypackage/')
# Create project from the cookieninja-pypackage.git repo template
cookiecutter('https://github.com/audreyfeldroy/cookieninja-pypackage.git')
Unless you suppress it with --no-input, you are prompted for input:
cookiecutter.json.cookiecutter.json.Cross-platform support for ~/.cookiecutterrc files:
default_context:
full_name: "Audrey Roy Greenfeld"
email: "audreyr@gmail.com"
github_username: "audreyfeldroy"
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 cookieninja-pypackage
$ cookieninja gh:audreyfeldroy/cookiecutter-pypackage
# Now you can use the already cloned cookieninja by name
$ cookieninja cookieninja-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:
cookieninja --no-input gh:msabramo/cookiecutter-supervisor program_name=foobar startsecs=10
Direct access to the Cookiecutter API allows for injection of extra context.
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.
Supports unlimited levels of directory nesting.
100% of templating is done with Jinja2.
Both, directory names and filenames can be templated. For example:
{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}.py
Simply define your template variables in a cookiecutter.json file.
For example:
{
"full_name": "Audrey Roy Greenfeld",
"email": "audreyr@gmail.com",
"project_name": "Complexity",
"repo_name": "complexity",
"project_short_description": "Refreshingly simple static site generator.",
"release_date": "2013-07-10",
"year": "2013",
"version": "0.1.0"
}
Pre- and post-generate hooks: Python or shell scripts to run before or after generating a project.
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.
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!
These Cookiecutters are maintained by the cookiecutter team:
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:
Development on Cookiecutter is community-driven:
Encouragement is unbelievably motivating. If you want more work done on Cookiecutter, show support:
Got criticism or complaints?
Waiting for a response to an issue/question?
This project is run by volunteers. Shortly we will be providing means for organizations and individuals to support the project.
Everyone interacting in the Cookiecutter project's codebases and documentation is expected to follow the PyPA Code of Conduct. This includes, but is not limited to, issue trackers, chat rooms, mailing lists, and other virtual or in real life communication.
The original cookiecutter project was created and is led by Audrey Roy Greenfeld.
The fork was created and maintained by Yuval Dolev and Lior Weissman.
Standard MoltPulse indexed agent.