mheppner / django-boilerplate

Basic Django boilerplate designed for easier deployment

Django Boilerplate

• Tested with Python 3 only
• Environment variables (or .env file) for configuration
• Basic health check endpoint
• Configs for flake8, pydocstyle, and editorconfig
• Circus deployment for managing processes
• Complete separation of runtime files (static/media files, logs, file-based cache, etc.)
• Basic Dockerfile

Requirements

• Python 3.5+

Installation

# create a virtual environment
python3.6 -m venv env
source env/bin/activate

# install requirements
pip install -r requirements/common.txt
# pip install -r requirements/dev.txt
# pip install -r requirements/prod.txt

# edit your local environment settings
cp .env.sample .env
vi .env

# apply migrations
cd src
./manage.py migrate

Deployment

# enter the virtual environment
source env/bin/activate

# make sure migrations are applied and gather static files
cd src
./manage.py migrate
./manage.py collectstatic --noinput

# start circus in the background
circusd --daemon circus.ini

# view process state
circusctl

# kill everything
kill `cat data/run/circusd.pid`

Docker

A Dockerfile is included that provides the full HTTP application, with bindings for pylibmc and PostgreSQL. To greatly reduce the container size, remove Nginx, PostgreSQL/psycopg2, and libmemcached/pylibmc. Be sure to migrate the database before starting.

mkdir -p /tmp/django-data/{cache,logs,media,run}

docker run -it \
    -v /tmp/django-data:/app/data \
    -p 8080:80 \
    -e SECRET_KEY=yoursecretkey \
    -e ALLOWED_HOSTS=yourdomainname.com \
    username/image