thermondo/django-project-template

Cookiecutter template for Django projects

django-project-template's Issues

Add repository setup instructions

See thermondo/django-package-template#5 for some inspiration.

Add documentation generator

Sphinx?

Add precommit

Add tests coverage setup

We track project coverage with tests right from the beginning.

Goes after (or with) #2 and #3.

Add Healthcheck suite

https://github.com/KristianOellegaard/django-health-check/

Add Heroku-related stuff

Things needed for full Heroku integration like:

• runtime.txt
• Procfile
• app.json

Add Django settings template

This should come with https://12factor.net/ in mind.

We usually have at least three config setups that are slightly different from each other: dev, test and production.

Open questions:

• Is django-configurations needed?
• django-environ?

Add pyup support

Consider "~" while creating a project as a command, not string

Currently, make create-project works only with a fully defined path, "~" is not acceptable there.

Add code checks (based on lambda lint)

https://lambdalint.github.io/

Add Makefile with useful devops commands

For example, stuff for reloading database

Add template base (builtin startproject or cookiecutter)

We need to select and implement either django builtin starproject template or use cookiecutter.

First, we need to add pros/cons for both and choose what fits best.

django builtin starproject

pros

• builtin (less effors to maintain)

cons

• lack of customization

cookiecutter

pros

• highly customizable
• possibility to add optional features (for example, optional celery, static, admin)

cons

• extra dependency to maintain

Add Sentry integration

Integration should support project environments (prod/test/review) and commits. In the same way, as backend does.

Set up template CI configuration

Enforce SSL

Set up template test runner

So freshly set project should have django/pytest runner working out of the box.
When #2 implemented, it should run automatically in CI system.

Add CONTRIBUTING.md, other GitHub templates

We need to add CONTRIBUTING.md, CODE_OF_CONDUCT.md. A simple example can be taken from here: https://github.com/Thermondo/django-heroku-connect

We might also consider adding PR and issue templates:
https://blog.github.com/2016-02-17-issue-and-pull-request-templates/