cookiecutter

v2.6.0

A command-line utility that creates projects from project templates, e.g. creating a Python package project from a Python package project template. For more information about how to use this package see README

Latest version published 10 months ago

License: BSD-3-Clause

PyPI

GitHub

Package Health Score

90 / 100

security
Security review needed
popularity
Key ecosystem project
maintenance
Healthy
community
Active

Explore Similar Packages

poetry
94

Popularity

Key ecosystem project

GitHub Stars: 22.76K
Forks: 2.01K
Contributors: 280

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package cookiecutter, we found that it has been starred 22,762 times.

Security

Security review needed

Security and license risk for latest version

Release Date: Feb 21, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

BSD-3-Clause

Security Policy

We found a way for you to contribute to the project! Looks like cookiecutter is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Healthy

Commit Frequency

Open Issues: 218
Open PR: 38
Last Release: 10 months ago
Last Commit: 6 months ago

Further analysis of the maintenance status of cookiecutter based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that cookiecutter demonstrates a positive version release cadence with at least one new version released in the past 12 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Active

Readme: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 280
Funding: No

A good and healthy external contribution signal for cookiecutter project, which invites more than one hundred open source maintainers to collaborate on the repository.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.7

Age: 11 years
Latest Release: 10 months ago
Dependencies: 8 Direct / 23 Total
Versions: 39
Maintainers: 5
Wheels: OS Independent

Readme

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, 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

# 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

$ pipx run cookiecutter cookiecutter-pypackage/

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('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

For Template Creators

Utilize unlimited directory nesting.
Employ Jinja2 for all templating needs.
Define template variables easily with cookiecutter.json.

Learn More

Available Templates

Discover a variety of ready-to-use templates on GitHub.

Special Templates

Community

Join the community, contribute, or seek assistance.

Support

Star us on GitHub.
Stay tuned for upcoming support options.

Feedback

We value your feedback. Share your criticisms or complaints constructively to help us improve.

File an Issue

Waiting for a Response?

Be patient and consider reaching out to the community for assistance.
For urgent matters, contact @audreyfeldroy for consultation or custom development.

Code of Conduct

Adhere to the PyPA Code of Conduct during all interactions in the project's ecosystem.

Acknowledgements

Created and led by Audrey Roy Greenfeld, supported by a dedicated team of maintainers and contributors.

cookiecutter dependencies

arrow binaryornot click jinja2 python-slugify pyyaml requests rich

FAQs

What is cookiecutter?

A command-line utility that creates projects from project templates, e.g. creating a Python package project from a Pyth... Visit Snyk Advisor to see a full health score report for cookiecutter, including popularity, security, maintenance & community analysis.

Is cookiecutter popular?

The python package cookiecutter receives a total of 1,139,473 weekly downloads. As such, cookiecutter popularity was classified as a key ecosystem project. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is cookiecutter well maintained?

We found that cookiecutter demonstrated a healthy version release cadence and project activity. It has a community of 280 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is cookiecutter safe to use?

While scanning the latest version of cookiecutter, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 13 December-2024, at 00:20 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Readme

Cookiecutter

Installation

Features

For Users

Quick Start

Detailed Usage

For Template Creators

Available Templates

Special Templates

Community

Support

Feedback

Waiting for a Response?

Code of Conduct

Acknowledgements

cookiecutter dependencies

FAQs

What is cookiecutter?

Is cookiecutter popular?

Is cookiecutter well maintained?

Is cookiecutter safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues