Source code
Revision control
Copy as Markdown
Other Tools
Metadata-Version: 2.1
Name: cookiecutter
Version: 2.6.0
Summary: A command-line utility that creates projects from project templates, e.g. creating a Python package project from a Python package project template.
Author: Audrey Feldroy
Author-email: audreyr@gmail.com
License: BSD
Keywords: cookiecutter,Python,projects,project templates,Jinja2,skeleton,scaffolding,project directory,package,packaging
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: AUTHORS.md
Requires-Dist: binaryornot >=0.4.4
Requires-Dist: Jinja2 <4.0.0,>=2.7
Requires-Dist: click <9.0.0,>=7.0
Requires-Dist: pyyaml >=5.3.1
Requires-Dist: python-slugify >=4.0.0
Requires-Dist: requests >=2.23.0
Requires-Dist: arrow
Requires-Dist: rich
<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://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.
## 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.12.
- **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.
### For Template Creators
- Utilize unlimited directory nesting.
- Employ Jinja2 for all templating needs.
- Define template variables easily with `cookiecutter.json`.
## Available Templates
Discover a variety of ready-to-use templates on [GitHub](https://github.com/search?q=cookiecutter&type=Repositories).
### Special Templates
## Community
Join the community, contribute, or seek assistance.
- [Contributors](AUTHORS.md)
- [Contribution Guide](CONTRIBUTING.md)
### Support
- Stay tuned for upcoming support options.
### Feedback
We value your feedback. Share your criticisms or complaints constructively to help us improve.
### 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.