django-dsfr 0.8.0

Integrate the French government Design System into a Django app

Django-DSFR

Django-DSFR is a Django app to integrate the French government Design System (“Système de design de l’État français”).

This app was created as a part of Open Collectivités and is very much a work in progress. See the documentation (in French) for details.

Django-DSFR (partly) implements the version 1.4.1 of the DSFR.

Requirements

Tested with Python 3.7 to 3.10 and Django 3.2.5 to 3.2.13. Per vermin, it should work with Python >= 3.0, and it should work with old versions of Django too.

Quick start

1. Install with pip install django-dsfr.

2. Add “widget_tweaks” and “dsfr” to INSTALLED_APPS in your settings.py like this, before the app you want to use it with:

   INSTALLED_APPS = [
       ...
       "widget_tweaks"
       "dsfr",
       <your_app>
   ]

3. Add the following settings so that the choice forms work:

   TEMPLATES = [
       {
           [...]
           "DIRS": [
               os.path.join(BASE_DIR, "dsfr/templates"),
               os.path.join(BASE_DIR, "templates"),
           ],
       },
   ]
   
   FORM_RENDERER = "django.forms.renderers.TemplatesSetting"

4. (Optional) Add the context processor to your settings.py and create an instance of “DsfrConfig” in the admin panel:

   TEMPLATES = [
       {
           [...]
           "OPTIONS": {
               "context_processors": [
                   [...]
                   "dsfr.context_processors.site_config",
               ],
           },
       },
   ]

5. Include the tags in your base.html file (see example file at https://github.com/entrepreneur-interet-general/django-dsfr/blob/main/example_app/templates/example_app/base.html)

6. Start the development server and visit http://127.0.0.1:8000/