Powered by Cookiecutter, Cookiecutter Django is a framework for jumpstarting production-ready Django projects quickly.
- Documentation: https://cookiecutter-django.readthedocs.io/en/latest/
- See Troubleshooting for common errors and obstacles
- For Django 1.9
- Renders Django projects with 100% starting test coverage
- Twitter Bootstrap v4.0.0 - alpha 3
- 12-Factor based settings via django-environ
- Optimized development and production settings
- Registration via django-allauth
- Comes with custom user model ready to go
- Grunt build for compass and livereload
- Send emails via Anymail (using Mailgun by default, but switchable)
- Media storage using Amazon S3
- Docker support using docker-compose for development and production
- Procfile for deploying to Heroku
- Instructions for deploying to PythonAnywhere
- Works with Python 2.7.x or 3.5.x
- Run tests with unittest or py.test
- Customizable PostgreSQL version
These features can be enabled during initial project setup.
- Serve static files from Amazon S3 or Whitenoise
- Configuration for Celery
- Integration with MailHog for local email testing
- Integration with Sentry for error logging
- Integration with Opbeat for performance monitoring
- Only maintained 3rd party libraries are used.
- Uses PostgreSQL everywhere (9.2+)
- Environment variables for configuration (This won't work with Apache/mod_wsgi).
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:
$ pip install cookiecutter
Now run it against this repo:
$ cookiecutter https://github.com/pydanny/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 [Project Name]: Reddit Clone project_slug [reddit_clone]: reddit author_name [Daniel Roy Greenfeld]: Daniel Greenfeld email [[email protected]]: [email protected] 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_python3 [y]: y 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 - Webpack 4 - None Choose from 1, 2, 3, 4 [1]: 1 use_lets_encrypt [n]: n 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
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 master
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:
- Have questions? Before you ask questions anywhere else, please post your question on Stack Overflow under the cookiecutter-django tag. We check there periodically for questions.
- If you think you found a bug or want to request a feature, please open an issue.
- For anything else, you can chat with us on Gitter.
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.
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.
Need a stable release? You can find them at https://github.com/pydanny/cookiecutter-django/releases
This is what I want. It might not be what you want. Don't worry, you have options:
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 or not to rename your fork.
If you do rename your fork, I encourage you to submit it to the following places:
- cookiecutter so it gets listed in the README as a template.
- The cookiecutter grid on Django Packages.
We accept pull requests if they're small, atomic, and make our own project development experience better.
- Development and Deployment of Cookiecutter-Django on Fedora - Jan. 18, 2016
- Development and Deployment of Cookiecutter-Django via Docker - Dec. 29, 2015
- How to create a Django Application using Cookiecutter and Django 1.8 - Sept. 12, 2015
- Introduction to Cookiecutter-Django - Feb. 19, 2016
- Django and GitLab - Running Continuous Integration and tests with your FREE account - May. 11, 2016
Have a blog or online publication? Write about your cookiecutter-django tips and tricks, then send us a pull request with the link.
Everyone interacting in the Cookiecutter project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the PyPA Code of Conduct.
This project is maintained by volunteers. Support their efforts by spreading the word about:
