haos616 / backend-skeleton

Django Stars Backend Skeleton

Django project template based on cookiecutter.

What's included

• Settings via environment variables with django-environ.
• Celery configuration.
• Django REST Framework configuration + Swagger with drf-yasg.
• Typical user CRUD APIs.
• Routine tasks configuration with fabric & invoke.
• Simple docker-compose configuration for local development (incl. Postgres, Redis & MailHog for testing emails).
• Requirements management with pip-tools.
• pytest configuration.
• Code formatting with Black.
• Imports sorting with isort.
• Checking code with bandit, mccabe, pycodestyle, pyflakes, pylint and radon.
• Pre-commit hook for running test & linters on each commit.
• CircleCI configuration for running tests & linters on each pull request.
• Integration with Sentry.

How to use

Create python virtual environment. We recommend to use pyenv & pyenv-virtualenv:

pyenv install 3.8.6
pyenv virtualenv 3.8.6 my_project
pyenv activate my_project

Install cookiecutter and packaging:

pip install cookiecutter packaging

Step into directory you want to create project and generate project with cookiecutter:

cd /path/to/directory
cookiecutter https://github.com/django-stars/backend-skeleton

Answer the questions.