# cookiecutter-django-docker

**Repository Path**: mirrors_ionelmc/cookiecutter-django-docker

## Basic Information

- **Project Name**: cookiecutter-django-docker
- **Description**: A minimalist but comprehensive template for Docker and Django projects
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-07-14
- **Last Updated**: 2026-05-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

==========================
cookiecutter-django-docker
==========================

A Cookiecutter_ template for a Django_ project using Docker_.
Continuation of `evozon/django-docker <https://github.com/evozon/django-docker>`_.

What is included?

* Packages for Django_ project and an app
* Setup for Celery_ or RQ_, Apache_, debug-toolbar etc
* LetsEncrypt_ setup with Nginx_ and uWSGI_.
* Setup for testing using Pytest_.
* Reloader (container that restarts other containers when files change, for development).
* Ansible deployment playbooks (that install Docker on the target machines and run your project with Compose).

Generating the project
----------------------

`Install cookiecutter <https://cookiecutter.readthedocs.io/en/latest/installation.html#install-cookiecutter>`_ and run::

    cookiecutter gh:ionelmc/cookiecutter-django-docker

You will be asked for these fields:

.. list-table::
    :header-rows: 1

    * - Template variable
      - Default
      - Description

    * - ``name``
      - .. code:: python

            "Nameless"
      - Project name, used in headings (readme, etc).

    * - ``repo_name``
      - .. code:: python

            "python-nameless"
      - The project's root directory name.

    * - ``django_project_name``
      - .. code:: python

            "nameless_project"
      - Django project name (a package that contains settings and root urls).

    * - ``compose_project_name``
      - .. code:: python

            "nmls"
      - Docker Compose project name (used for the COMPOSE_PROJECT_NAME setting). A short name is suggested to avoid
        typing a lot when using Docker directly (eg: ``docker exec nmls_web_1 ...``)

    * - ``django_app_name``
      - .. code:: python

            "nameless"
      - Django app name.

    * - ``short_description``
      - .. code:: python

            "An example package [...]"
      - One line description of the project (used in ``README.rst``).

Regenerating the project
------------------------

If you made some wrong choices during generation you can regenerate it. There are two options:

* Force Cookiecutter_ to override the files::

    cookiecutter --overwrite-if-exists --config-file=directory-of-project/.cookiecutterrc gh:ionelmc/cookiecutter-django-docker

* After installing `cookiepatcher <https://pypi.org/project/cookiepatcher/>`_ run::

    cookiepatcher gh:ionelmc/cookiecutter-django-docker directory-of-project

Using the project
-----------------

To build the project::

    docker compose build --pull

This template previously had a base image but it's just too much of a hassle and
layer caching work well enough to have individual images.

To start the project run::

    docker compose up

The project will provide a small shim for running tests, try::

  ./test.sh --help

Working with the project is the usual ``docker compose up`` and such, nothing special or unexpected.

.. _Pytest: http://pytest.org/
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _Docker: https://www.docker.com/
.. _Django: https://www.djangoproject.com/
.. _Celery: http://www.celeryproject.org/
.. _RQ: https://python-rq.org/
.. _uWSGI: https://uwsgi-docs.readthedocs.io/
.. _Apache: https://httpd.apache.org/
.. _Ansible: https://docs.ansible.com/ansible/latest/
.. _LetsEncrypt: https://letsencrypt.org/
.. _Nginx: nginx.org/