Learn best practices from cookiecutter-django

Introduction

This article is the 7th day of Django Advent Calendar 2016.

What to do here

cookiecutter-Introducing django
Learn useful packages
Learn useful external services
Learn directory structure

What is cookie cutter

https://github.com/audreyr/cookiecutter

A command-line utility that creates projects from cookiecutters (project templates). E.g. Python package projects, jQuery plugin projects.

CLI tool for creating Python project templates

$ pip install cookiecutter
$ cookiecutter [repository]

What is cookiecutter-django?

Introduced in Two Scoops of Django: Best Practices for Django 1.8
About this book, @aki_yok on the 5th day said Best of Django book! --akiyoko blog
Django Packages: Cookiecutters and [Search on GitHub](https://github.com/search?utf8=%E2%9C%93&q= Most popular in django + cookiecutter)

$ cookiecutter https://github.com/pydanny/cookiecutter-django

Configuration options

Project Generation Options — Cookiecutter Django 2016.49.3 documentation

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
use_elasticbeanstalk_experimental: n

Features

For Django 1.10
Renders Django projects with 100% starting test coverage
Twitter Bootstrap v4.0.0 - alpha 4 (maintained Foundation fork also available)
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
Experimental support for Amazon Elastic Beanstalk

Optional Integrations

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

Package introduction

Bootstrap
Front-end framework
django-environ
Environment variable management
django-allauth
Account verification
django-anymail
Email backend for each ESP

Service that can be linked

WhiteNoise
Static file delivery
Default is Amazon S3
Celery
Task queue
MailHog
Email test
Sentry
Error tracking
Opbeat
Performance monitoring

Directory structure

~
├── compose
│   ├── django
│   │   ├── Dockerfile
│   │   ├── Dockerfile-dev
│   │   ├── entrypoint.sh
│   │   ├── gunicorn.sh
│   │   └── start-dev.sh
│   ├── nginx
│   │   ├── Dockerfile
│   │   └── nginx.conf
│   └── postgres
│       ├── Dockerfile
│       ├── backup.sh
│       ├── list-backups.sh
│       └── restore.sh
~
├── config
│   ├── __init__.py
│   ├── settings
│   │   ├── __init__.py
│   │   ├── common.py
│   │   ├── local.py
│   │   ├── production.py
│   │   └── test.py
│   ├── urls.py
│   └── wsgi.py
~
├── requirements
│   ├── base.txt
│   ├── local.txt
│   ├── production.txt
│   └── test.txt

Create a compose directory for docker-compose
File storage for each environment in the settings directory
File storage for each environment in the requirements directory

I think this area will be helpful. For other configurations, actually create a project and check it.

in conclusion

I've briefly described cookiecutter-django. I think you'll get some insight into developing with Django, so feel free to touch it!

By the way, in Django development, if you check Awesome Django, you will find something new.