django-devkit

Develop and test Django applications in a portable containerized development environment.

The app files are available locally and you can edit them with the editor of your choice. All the commands are run in a container. You do not need to install Python or any of the dependencies locally.

Django-devkit uses Python 3.7 and Django 2.2.2 by default.

Postgres is included via docker-compose.

Requirements

Docker and docker-compose are required. Docker must be running. Make is not required (you can run all the Docker and docker-commands without it); it is only required for easily using the shortcuts described below.

Get started

make build

This will build the necessary container(s).

Run tests

make test

Lint code

make lint

Generate test coverage report

make coverage

Run the app locally for development

make up

To stop the app:

make down

View logs

make logs

Django commands

createsuperuser:

make createsuperuser

makemigrations:

make makemigrations APP=<name of app>

migrate:

make migrate

shell:

make shell

startproject:

make startproject PROJECT=<name of project> .

startapp:

make startapp APP=<name of app>

Pipenv commands

install:

make install PKG=<name of package (optionally==version)>

install --dev:

make installdev PKG=<name of package (optionally==version)>

uninstall:

make uninstall PKG=<name of package>