cookiecutter-django README

The project's README from github.com/cookiecutter/cookiecutter-django. As one markdown file: README.md.

Cookiecutter Django

Build Status Documentation Status pre-commit.ci status Code style: black

Updates Join our Discord Code Helpers Badge

Powered by Cookiecutter, Cookiecutter Django is a framework for jumpstarting production-ready Django projects quickly.

Features

Optional Integrations

These features can be enabled during initial project setup.

Constraints

Support this Project!

This project is an open source project run by volunteers. You can sponsor us via OpenCollective or individually via GitHub Sponsors:

Projects that provide financial support to the maintainers:

Two Scoops of Django

Cover of the book

Two Scoops of Django 3.x is the best ice cream-themed Django reference in the universe!

PyUp

PyUp Logo

PyUp brings you automated security and dependency updates used by Google and other organizations. Free for open source projects!

Usage

Let's pretend you want to create a Django project called "redditclone". Rather than using startproject and then editing the results to include your name, email, and various configuration issues that always get forgotten until the worst possible moment, get cookiecutter to do all the work.

First, get Cookiecutter. Trust me, it's awesome:

uv tool install "cookiecutter>=1.7.0"

Now run it against this repo:

uvx cookiecutter https://github.com/cookiecutter/cookiecutter-django

You'll be prompted for some values. Provide them, then a Django project will be created for you.

Warning: After this point, change 'Daniel Greenfeld', 'pydanny', etc to your own information.

Answer the prompts with your own desired options. For example:

Cloning into 'cookiecutter-django'...
remote: Counting objects: 550, done.
remote: Compressing objects: 100% (310/310), done.
remote: Total 550 (delta 283), reused 479 (delta 222)
Receiving objects: 100% (550/550), 127.66 KiB | 58 KiB/s, done.
Resolving deltas: 100% (283/283), done.
project_name [My Awesome Project]: Reddit Clone
project_slug [reddit_clone]: reddit
description [Behold My Awesome Project!]: A reddit clone.
author_name [Daniel Roy Greenfeld]: Daniel Greenfeld
domain_name [example.com]: myreddit.com
email [[email protected]]: [email protected]
version [0.1.0]: 0.0.1
Select open_source_license:
1 - MIT
2 - BSD
3 - GPLv3
4 - Apache Software License 2.0
5 - Not open source
Choose from 1, 2, 3, 4, 5 [1]: 1
Select username_type:
1 - username
2 - email
Choose from 1, 2 [1]: 1
timezone [UTC]: America/Los_Angeles
windows [n]: n
Select an editor to use. The choices are:
1 - None
2 - PyCharm
3 - VS Code
Choose from 1, 2, 3 [1]: 1
use_docker [n]: n
Select postgresql_version:
1 - 18
2 - 17
3 - 16
4 - 15
5 - 14
Choose from 1, 2, 3, 4 [1]: 1
Select cloud_provider:
1 - AWS
2 - GCP
3 - None
Choose from 1, 2, 3 [1]: 1
Select mail_service:
1 - Mailgun
2 - Amazon SES
3 - Mailjet
4 - Mandrill
5 - Postmark
6 - Sendgrid
7 - Brevo (formerly SendinBlue)
8 - SparkPost
9 - Other SMTP
Choose from 1, 2, 3, 4, 5, 6, 7, 8, 9 [1]: 1
Select rest_api [None]:
1 - None
2 - DRF
3 - Django Ninja
Choose from 1, 2, 3 [1]: 1
use_async [n]: n
Select frontend_pipeline:
1 - None
2 - Django Compressor
3 - Gulp
4 - Webpack
Choose from 1, 2, 3, 4 [1]: 1
use_celery [n]: y
Select mail_catcher:
1 - None
2 - Mailpit
3 - Mailtrap Local
Choose from 1, 2, 3 [1]: 1
use_sentry [n]: y
use_whitenoise [n]: n
use_heroku [n]: y
Select ci_tool:
1 - None
2 - Travis
3 - Gitlab
4 - Github
Choose from 1, 2, 3, 4 [1]: 4
keep_local_envs_in_vcs [y]: y
debug [n]: n

Enter the project and take a look around:

cd reddit/
ls

Create a git repo and push it there:

git init
git add .
git commit -m "first awesome commit"
git remote add origin [email protected]:pydanny/redditclone.git
git push -u origin main

Now take a look at your repo. Don't forget to carefully look at the generated README. Awesome, right?

For local development, see the following:

Community

Contributors

For Readers of Two Scoops of Django

You may notice that some elements of this project do not exactly match what we describe in chapter 3. The reason for that is this project, amongst other things, serves as a test bed for trying out new ideas and concepts. Sometimes they work, sometimes they don't, but the end result is that it won't necessarily match precisely what is described in the book I co-authored.

For PyUp Users

If you are using PyUp to keep your dependencies updated and secure, use the code cookiecutter during checkout to get 15% off every month.

"Your Stuff"

Scattered throughout the Python and HTML of this project are places marked with "your stuff". This is where third-party libraries are to be integrated with your project.

For MySQL users

To get full MySQL support in addition to the default Postgresql, you can use this fork of the cookiecutter-django: https://github.com/mabdullahadeel/cookiecutter-django-mysql

Releases

Need a stable release? You can find them at https://github.com/cookiecutter/cookiecutter-django/releases

Not Exactly What You Want?

This is what I want. It might not be what you want. Don't worry, you have options:

Fork This

If you have differences in your preferred setup, I encourage you to fork this to create your own version. Once you have your fork working, let me know and I'll add it to a 'Similar Cookiecutter Templates' list here. It's up to you whether to rename your fork.

If you do rename your fork, I encourage you to submit it to the following places:

Submit a Pull Request

We accept pull requests if they're small, atomic, and make our own project development experience better.

Articles

Have a blog or online publication? Write about your cookiecutter-django tips and tricks, then send us a pull request with the link.

cookiecutter-django (cookiecutter/cookiecutter-django)

Searching Database…

13.6K ·GitHub
Cookiecutter-django
Что это такое?Cookiecutter Django — это шаблон проекта, который создаёт готовый к продакшну скелет Django-проекта с уже подключенными распространёнными инструментами: Celery, Docker, сервисами отправки почты, Sentry и конфигурацией CI, так что не нужно начинать с пустого репозитория.
Это библиотека, которую я подключаю, или одноразовый генератор?Это одноразовый шаблон-каркас на основе Cookiecutter: вы запускаете его один раз, чтобы сгенерировать полноценный Django-проект с выбранными вами настройками, а дальше разрабатываете уже сгенерированный проект самостоятельно.
Как создать новый проект с его помощью?Запустите 'uvx cookiecutter' для этого репозитория (или установите cookiecutter >=1.7.0 и запустите так же); система запросит название проекта, описание, данные автора и серию выборов функций.
Что нужно установить перед запуском генератора?Для запуска самого генератора нужен установленный cookiecutter версии 1.7.0 или выше.
Код сгенерированного проекта полностью совпадает с книгой 'Two Scoops of Django'?Нет — автор отмечает, что этот проект служит полигоном для новых идей, поэтому часть сгенерированного кода намеренно отличается от того, что описано в этой книге.
Можно ли сгенерировать проект на Windows?Да, в вопросах генератора прямо есть вариант 'windows', так что сгенерированный проект можно настроить для разработки под Windows.
Какие функции можно выбрать при генерации?Генератор позволяет выбрать открытую лицензию, часовой пояс, конфигурацию редактора (PyCharm/VS Code), использование Docker, версию PostgreSQL, облачного провайдера (AWS/GCP), почтовый сервис (Mailgun, SES, Sendgrid и др.), фреймворк для REST API (DRF или Django Ninja), Celery, Sentry и инструмент CI (Travis, GitLab, GitHub Actions).
Поддерживается ли MySQL вместо PostgreSQL?Напрямую нет — в README указан отдельный форк cookiecutter-django от сообщества, где полностью поддерживается MySQL наряду с PostgreSQL, который используется по умолчанию.
А если нужна настройка, отличная от стандартной?Автор предлагает форкнуть шаблон и создать собственную версию, а также готов перечислить форки от сообщества в разделе 'Similar Cookiecutter Templates'.
What are similar projects?cookiecutter, cookiecutter-data-science, awesome-cheatsheets, wagtail, aws-cdk, apprise, routersploit, django-cms
Which topics is it in?heroku, django, boilerplate, bsd, sdk, hacktoberfest, command-line-tool, framework, docker, cli, python, developer-tools
Creator
cookiecutter
Size
13.2 MB
Stars
13.6K
Updated
CommitOct 16Release2026.10.15Oct 16
Age
13y
Commits · 90 Days