<h1 align="center">
<img alt="cookiecutter Logo" width="200px" src="https://raw.githubusercontent.com/cookiecutter/cookiecutter/3ac078356adf5a1a72042dfe72ebfa4a9cd5ef38/logo/cookiecutter_medium.png">
</h1>
<div align="center">
[](https://pypi.org/project/cookiecutter/)
[](https://pypi.org/project/cookiecutter/)
[](https://github.com/cookiecutter/cookiecutter/actions)
[](https://codecov.io/github/cookiecutter/cookiecutter?branch=master)
[](https://discord.gg/9BrxzPKuEW)
[](https://readthedocs.org/projects/cookiecutter/?badge=latest)
[](https://scrutinizer-ci.com/g/cookiecutter/cookiecutter/?branch=master)
</div>
# Cookiecutter
Create projects swiftly from **cookiecutters** (project templates) with this command-line utility. Ideal for generating Python package projects and more.
- [Documentation](https://cookiecutter.readthedocs.io)
- [GitHub](https://github.com/cookiecutter/cookiecutter)
- [PyPI](https://pypi.org/project/cookiecutter/)
- [License (BSD)](https://github.com/cookiecutter/cookiecutter/blob/main/LICENSE)
## Installation
Install cookiecutter using pip package manager:
```
# pipx is strongly recommended.
pipx install cookiecutter
# If pipx is not an option,
# you can install cookiecutter in your Python user directory.
python -m pip install --user cookiecutter
```
## Features
- **Cross-Platform:** Supports Windows, Mac, and Linux.
- **User-Friendly:** No Python knowledge required.
- **Versatile:** Compatible with Python 3.7 to 3.11.
- **Multi-Language Support:** Use templates in any language or markup format.
### For Users
#### Quick Start
The recommended way to use Cookiecutter as a command line utility is to run it with [`pipx`](https://pypa.github.io/pipx/), which can be installed with `pip install pipx`, but if you plan to use Cookiecutter programmatically, please run `pip install cookiecutter`.
**Use a GitHub template**
```bash
# You'll be prompted to enter values.
# Then it'll create your Python package in the current working directory,
# based on those values.
# For the sake of brevity, repos on GitHub can just use the 'gh' prefix
$ pipx run cookiecutter gh:audreyfeldroy/cookiecutter-pypackage
```
**Use a local template**
```bash
$ pipx run cookiecutter cookiecutter-pypackage/
```
**Use it from Python**
```py
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('gh:audreyfeldroy//cookiecutter-pypackage.git')
```
#### Detailed Usage
- Generate projects from local or remote templates.
- Customize projects with `cookiecutter.json` prompts.
- Utilize pre-prompt, pre- and post-generate hooks.
[Learn More](https://cookiecutter.readthedocs.io/en/latest/usage.html)
### For Template Creators
- Utilize unlimited directory nesting.
- Employ Jinja2 for all templating needs.
- Define template variables easily with `cookiecutter.json`.
[Learn More](https://cookiecutter.readthedocs.io/en/latest/tutorials/)
## Available Templates
Discover a variety of ready-to-use templates on [GitHub](https://github.com/search?q=cookiecutter&type=Repositories).
### Special Templates
- [cookiecutter-pypackage](https://github.com/audreyfeldroy/cookiecutter-pypackage)
- [cookiecutter-django](https://github.com/pydanny/cookiecutter-django)
- [cookiecutter-pytest-plugin](https://github.com/pytest-dev/cookiecutter-pytest-plugin)
- [cookiecutter-plone-starter](https://github.com/collective/cookiecutter-plone-starter)
## Community
Join the community, contribute, or seek assistance.
- [Troubleshooting Guide](https://cookiecutter.readthedocs.io/en/latest/troubleshooting.html)
- [Stack Overflow](https://stackoverflow.com/questions/tagged/cookiecutter)
- [Discord](https://discord.gg/9BrxzPKuEW)
- [File an Issue](https://github.com/cookiecutter/cookiecutter/issues?q=is%3Aopen)
- [Contributors](AUTHORS.md)
- [Contribution Guide](CONTRIBUTING.md)
### Support
- Star us on [GitHub](https://github.com/cookiecutter/cookiecutter).
- Stay tuned for upcoming support options.
### Feedback
We value your feedback. Share your criticisms or complaints constructively to help us improve.
- [File an Issue](https://github.com/cookiecutter/cookiecutter/issues?q=is%3Aopen)
### Waiting for a Response?
- Be patient and consider reaching out to the community for assistance.
- For urgent matters, contact [@audreyfeldroy](https://github.com/audreyfeldroy) for consultation or custom development.
## Code of Conduct
Adhere to the [PyPA Code of Conduct](https://www.pypa.io/en/latest/code-of-conduct/) during all interactions in the project's ecosystem.
## Acknowledgements
Created and led by [Audrey Roy Greenfeld](https://github.com/audreyfeldroy), supported by a dedicated team of maintainers and contributors.
Raw data
{
"_id": null,
"home_page": "https://github.com/cookiecutter/cookiecutter",
"name": "cookiecutter",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "cookiecutter,Python,projects,project templates,Jinja2,skeleton,scaffolding,project directory,package,packaging",
"author": "Audrey Feldroy",
"author_email": "audreyr@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/1a/5d/9f6a7b748436597060654c8b5815dabedd78893e566bc9838c6dcbf05e04/cookiecutter-2.5.0.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">\n <img alt=\"cookiecutter Logo\" width=\"200px\" src=\"https://raw.githubusercontent.com/cookiecutter/cookiecutter/3ac078356adf5a1a72042dfe72ebfa4a9cd5ef38/logo/cookiecutter_medium.png\">\n</h1>\n\n<div align=\"center\">\n\n[](https://pypi.org/project/cookiecutter/)\n[](https://pypi.org/project/cookiecutter/)\n[](https://github.com/cookiecutter/cookiecutter/actions)\n[](https://codecov.io/github/cookiecutter/cookiecutter?branch=master)\n[](https://discord.gg/9BrxzPKuEW)\n[](https://readthedocs.org/projects/cookiecutter/?badge=latest)\n[](https://scrutinizer-ci.com/g/cookiecutter/cookiecutter/?branch=master)\n\n</div>\n\n# Cookiecutter\n\nCreate projects swiftly from **cookiecutters** (project templates) with this command-line utility. Ideal for generating Python package projects and more.\n\n- [Documentation](https://cookiecutter.readthedocs.io)\n- [GitHub](https://github.com/cookiecutter/cookiecutter)\n- [PyPI](https://pypi.org/project/cookiecutter/)\n- [License (BSD)](https://github.com/cookiecutter/cookiecutter/blob/main/LICENSE)\n\n## Installation\n\nInstall cookiecutter using pip package manager:\n```\n# pipx is strongly recommended.\npipx install cookiecutter\n\n# If pipx is not an option,\n# you can install cookiecutter in your Python user directory.\npython -m pip install --user cookiecutter\n```\n\n## Features\n\n- **Cross-Platform:** Supports Windows, Mac, and Linux.\n- **User-Friendly:** No Python knowledge required.\n- **Versatile:** Compatible with Python 3.7 to 3.11.\n- **Multi-Language Support:** Use templates in any language or markup format.\n\n### For Users\n\n#### Quick Start\n\nThe recommended way to use Cookiecutter as a command line utility is to run it with [`pipx`](https://pypa.github.io/pipx/), which can be installed with `pip install pipx`, but if you plan to use Cookiecutter programmatically, please run `pip install cookiecutter`.\n\n**Use a GitHub template**\n\n```bash\n# You'll be prompted to enter values.\n# Then it'll create your Python package in the current working directory,\n# based on those values.\n# For the sake of brevity, repos on GitHub can just use the 'gh' prefix\n$ pipx run cookiecutter gh:audreyfeldroy/cookiecutter-pypackage\n```\n\n**Use a local template**\n\n```bash\n$ pipx run cookiecutter cookiecutter-pypackage/\n```\n\n**Use it from Python**\n\n```py\nfrom cookiecutter.main import cookiecutter\n\n# Create project from the cookiecutter-pypackage/ template\ncookiecutter('cookiecutter-pypackage/')\n\n# Create project from the cookiecutter-pypackage.git repo template\ncookiecutter('gh:audreyfeldroy//cookiecutter-pypackage.git')\n```\n\n#### Detailed Usage\n\n- Generate projects from local or remote templates.\n- Customize projects with `cookiecutter.json` prompts.\n- Utilize pre-prompt, pre- and post-generate hooks.\n\n[Learn More](https://cookiecutter.readthedocs.io/en/latest/usage.html)\n\n### For Template Creators\n\n- Utilize unlimited directory nesting.\n- Employ Jinja2 for all templating needs.\n- Define template variables easily with `cookiecutter.json`.\n\n[Learn More](https://cookiecutter.readthedocs.io/en/latest/tutorials/)\n\n## Available Templates\n\nDiscover a variety of ready-to-use templates on [GitHub](https://github.com/search?q=cookiecutter&type=Repositories).\n\n### Special Templates\n\n- [cookiecutter-pypackage](https://github.com/audreyfeldroy/cookiecutter-pypackage)\n- [cookiecutter-django](https://github.com/pydanny/cookiecutter-django)\n- [cookiecutter-pytest-plugin](https://github.com/pytest-dev/cookiecutter-pytest-plugin)\n- [cookiecutter-plone-starter](https://github.com/collective/cookiecutter-plone-starter)\n\n## Community\n\nJoin the community, contribute, or seek assistance.\n\n- [Troubleshooting Guide](https://cookiecutter.readthedocs.io/en/latest/troubleshooting.html)\n- [Stack Overflow](https://stackoverflow.com/questions/tagged/cookiecutter)\n- [Discord](https://discord.gg/9BrxzPKuEW)\n- [File an Issue](https://github.com/cookiecutter/cookiecutter/issues?q=is%3Aopen)\n- [Contributors](AUTHORS.md)\n- [Contribution Guide](CONTRIBUTING.md)\n\n### Support\n\n- Star us on [GitHub](https://github.com/cookiecutter/cookiecutter).\n- Stay tuned for upcoming support options.\n\n### Feedback\n\nWe value your feedback. Share your criticisms or complaints constructively to help us improve.\n\n- [File an Issue](https://github.com/cookiecutter/cookiecutter/issues?q=is%3Aopen)\n\n### Waiting for a Response?\n\n- Be patient and consider reaching out to the community for assistance.\n- For urgent matters, contact [@audreyfeldroy](https://github.com/audreyfeldroy) for consultation or custom development.\n\n## Code of Conduct\n\nAdhere to the [PyPA Code of Conduct](https://www.pypa.io/en/latest/code-of-conduct/) during all interactions in the project's ecosystem.\n\n## Acknowledgements\n\nCreated and led by [Audrey Roy Greenfeld](https://github.com/audreyfeldroy), supported by a dedicated team of maintainers and contributors.\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "A command-line utility that creates projects from project templates, e.g. creating a Python package project from a Python package project template.",
"version": "2.5.0",
"project_urls": {
"Discord": "https://discord.gg/9BrxzPKuEW",
"Documentation": "https://cookiecutter.readthedocs.io",
"Homepage": "https://github.com/cookiecutter/cookiecutter",
"Issues": "https://github.com/cookiecutter/cookiecutter/issues"
},
"split_keywords": [
"cookiecutter",
"python",
"projects",
"project templates",
"jinja2",
"skeleton",
"scaffolding",
"project directory",
"package",
"packaging"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d13291af80d3ecbe0113ae26cdaa623a3def2319a02c1eafe91733ac45133afd",
"md5": "4e43ed0cbce0e8bc6177f2f4099c2590",
"sha256": "8aa2f12ed11bc05628651e9dc4353a10571dd9908aaaaeec959a2b9ea465a5d2"
},
"downloads": -1,
"filename": "cookiecutter-2.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4e43ed0cbce0e8bc6177f2f4099c2590",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 39080,
"upload_time": "2023-11-21T16:41:53",
"upload_time_iso_8601": "2023-11-21T16:41:53.629667Z",
"url": "https://files.pythonhosted.org/packages/d1/32/91af80d3ecbe0113ae26cdaa623a3def2319a02c1eafe91733ac45133afd/cookiecutter-2.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1a5d9f6a7b748436597060654c8b5815dabedd78893e566bc9838c6dcbf05e04",
"md5": "8d64c91c89d9c5a2a279dbfe7db96518",
"sha256": "e61e9034748e3f41b8bd2c11f00d030784b48711c4d5c42363c50989a65331ec"
},
"downloads": -1,
"filename": "cookiecutter-2.5.0.tar.gz",
"has_sig": false,
"md5_digest": "8d64c91c89d9c5a2a279dbfe7db96518",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 157269,
"upload_time": "2023-11-21T16:41:55",
"upload_time_iso_8601": "2023-11-21T16:41:55.173526Z",
"url": "https://files.pythonhosted.org/packages/1a/5d/9f6a7b748436597060654c8b5815dabedd78893e566bc9838c6dcbf05e04/cookiecutter-2.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-21 16:41:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cookiecutter",
"github_project": "cookiecutter",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"test_requirements": [],
"tox": true,
"lcname": "cookiecutter"
}
JSON
