Package: cookiecutter-django
Powered byCookiecutter, Cookiecutter Django is a framework for jumpstarting
production-ready Django projects quickly.Documentation:https://cookiecutter-django.readthedocs.io/en/latest/SeeTroubleshootingfor common errors and obstaclesIf you have problems with Cookiecutter Django, please openissuesdon’t send
emails to the maintainers.Need quick professional paid support? Contactsupport@cookiecutter.io.
This includes configuring your servers, fixing bugs, reviewing your code and
everything in between.FeaturesFor Django 1.11Works with Python 3.6Renders Django projects with 100% starting test coverageTwitterBootstrapv4.0.0 - beta 1 (maintained Foundation forkalso available)12-Factorbased settings viadjango-environSecure by default. We believe in SSL.Optimized development and production settingsRegistration viadjango-allauthComes with custom user model ready to goGrunt build for compass and livereloadSend emails viaAnymail(usingMailgunby default, but switchable)Media storage using Amazon S3Docker support usingdocker-composefor development and production (usingCaddywithLetsEncryptsupport)Procfilefor deploying to HerokuInstructions for deploying toPythonAnywhereRun tests with unittest or py.testCustomizable PostgreSQL versionOptional IntegrationsThese features can be enabled during initial project setup.Serve static files from Amazon S3 orWhitenoiseConfiguration forCeleryIntegration withMailHogfor local email testingIntegration withSentryfor error loggingIntegration withOpbeatfor performance monitoringConstraintsOnly maintained 3rd party libraries are used.Uses PostgreSQL everywhere (9.2+)Environment variables for configuration (This won’t work with Apache/mod_wsgi except on AWS ELB).Support this Project!This project is run by volunteers. Please support them in their efforts to maintain and improve Cookiecutter Django:https://www.patreon.com/danielroygreenfeld: Project lead. Expertise in AWS ELB and Django.Projects that provide financial support to the maintainers:Two Scoops of Django 1.11Two Scoops of Django is the best dessert-themed Django reference in the universepyupPyup brings you automated security and dependency updates used by Google and other organizations. Free for open source projects!UsageLet’s pretend you want to create a Django project called “redditclone”. Rather than usingstartprojectand then editing the results to include your name, email, and various configuration issues that always get forgotten until the worst possible moment, getcookiecutterto do all the work.First, get Cookiecutter. Trust me, it’s awesome:$ pip install "cookiecutter>=1.4.0"Now run it against this repo:$ cookiecutter https://github.com/pydanny/cookiecutter-djangoYou’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 desiredoptions. 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 [Project Name]: Reddit Clone
project_slug [reddit_clone]: reddit
author_name [Daniel Roy Greenfeld]: Daniel Greenfeld
email [you@example.com]: pydanny@gmail.com
description [A short description of the project.]: A reddit clone.
domain_name [example.com]: myreddit.com
version [0.1.0]: 0.0.1
timezone [UTC]: America/Los_Angeles
use_whitenoise [y]: n
use_celery [n]: y
use_mailhog [n]: n
use_sentry_for_error_reporting [y]: y
use_opbeat [n]: y
use_pycharm [n]: y
windows [n]: n
use_docker [y]: n
use_heroku [n]: y
use_compressor [n]: y
Select postgresql_version:
1 - 9.5
2 - 9.4
3 - 9.3
4 - 9.2
Choose from 1, 2, 3, 4 [1]: 1
Select js_task_runner:
1 - Gulp
2 - Grunt
3 - None
Choose from 1, 2, 3, 4 [1]: 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]: 1Enter the project and take a look around:$ cd reddit/
$ lsCreate a git repo and push it there:$ git init
$ git add .
$ git commit -m "first awesome commit"
$ git remote add origin git@github.com:pydanny/redditclone.git
$ git push -u origin masterNow take a look at your repo. Don’t forget to carefully look at the generated README. Awesome, right?For local development, see the following:Developing locallyDeveloping locally using dockerCommunityHave questions?Before you ask questions anywhere else, please post your question onStack Overflowunder thecookiecutter-djangotag. We check there periodically for questions.If you think you found a bug or want to request a feature, please open anissue.For anything else, you can chat with us onGitter.For Readers of Two Scoops of DjangoYou 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.io UsersIf you are usingpyup.ioto keep your dependencies updated and secure, use the codecookiecutterduring 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.ReleasesNeed a stable release? You can find them athttps://github.com/pydanny/cookiecutter-django/releasesNot Exactly What You Want?This is what I want.It might not be what you want.Don’t worry, you have options:Fork ThisIf 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 or not to rename your fork.If you do rename your fork, I encourage you to submit it to the following places:cookiecutterso it gets listed in the README as a template.The cookiecuttergridon Django Packages.Submit a Pull RequestWe accept pull requests if they’re small, atomic, and make our own project development
experience better.ArticlesDevelopment and Deployment of Cookiecutter-Django on Fedora- Jan. 18, 2016Development and Deployment of Cookiecutter-Django via Docker- Dec. 29, 2015How to create a Django Application using Cookiecutter and Django 1.8- Sept. 12, 2015Introduction to Cookiecutter-Django- Feb. 19, 2016Django and GitLab - Running Continuous Integration and tests with your FREE account- May. 11, 2016Have a blog or online publication? Write about your cookiecutter-django tips and tricks, then send us a pull request with the link.Code of ConductEveryone interacting in the Cookiecutter project’s codebases, issue trackers, chat
rooms, and mailing lists is expected to follow thePyPA Code of Conduct.