Beta x Django

Introduction

Ce repo est un kit de démarrage pour vos projets en Django. Il intègre :

• le Design System de l'Etat (DSFR) avec django-dsfr
• des Content Security Policies avec django-csp
• Pre-commit, pour formatter votre code à chaque commit
• une ébauche de CI pour vos tests automatiques
• les paramètres pour se connecter à une base de données PostgreSQL

Use

# Activate your desired environment with
. venv/bin/activate

# and run server
python manage.py runserver

Installation

Edit .env

Copier les variables d'environnement :

cp .env.example .env

puis modifier en le contenu pour correspondre à votre configuration.

Installer l'environnement

python -m venv venv 

. venv/bin/activate
pip install --upgrade pip
pip install -r requirements.txt

Configurer la base de données

Installer PostgreSQL en fonction de votre OS : https://www.postgresql.org/download/ puis créer une base de données au nom choisi dans DATABASE_URI de votre fichier .env.

python manage.py migrate

Installation de pre-commit

Pre-commit permet de linter et formatter votre code avant chaque commit. Par défaut ici, il exécute :

• black pour formatter automatiquement vos fichiers .py en conformité avec la PEP 8 (gestion des espaces, longueur des lignes, etc)
• flake8 pour soulever les "infractions" restantes (import non utilisés, etc)
• isort pour ordonner vos imports

Pour l'installer :

pre-commit install

Vous pouvez effectuer un premier passage sur tous les fichiers du repo avec :

pre-commit run --all-files

Exécuter les tests manuellement

python manage.py test