Metadata-Version: 2.1
Name: django-dsfr
Version: 0.4.6
Summary: Integrate the French government Design System into a Django app
Home-page: https://github.com/entrepreneur-interet-general/django-dsfr
License: MIT
Keywords: django
Author: Sylvain Boissel
Author-email: sylvain.boissel@dgcl.gouv.fr
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 3.2
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Utilities
Requires-Dist: Django (>=3.2.5,<4.0.0)
Requires-Dist: requests (>=2.26.0,<3.0.0)
Project-URL: Documentation, https://entrepreneur-interet-general.github.io/django-dsfr
Project-URL: Repository, https://github.com/entrepreneur-interet-general/django-dsfr
Description-Content-Type: text/x-rst

.. image:: https://badge.fury.io/py/django-dsfr.svg
    :target: https://pypi.org/project/django-dsfr/

.. image:: https://github.com/entrepreneur-interet-general/django-dsfr/actions/workflows/django.yml/badge.svg
    :target: https://github.com/entrepreneur-interet-general/django-dsfr/actions/workflows/django.yml

.. image:: https://github.com/entrepreneur-interet-general/django-dsfr/actions/workflows/codeql-analysis.yml/badge.svg
    :target: https://github.com/entrepreneur-interet-general/django-dsfr/actions/workflows/codeql-analysis.yml


===========
Django-DSFR
===========

Django-DSFR is a Django app to integrate the `French government Design System ("Système de design de l’État français") <https://www.systeme-de-design.gouv.fr/>`_.


This app was created as a part of `Open Collectivités <https://github.com/entrepreneur-interet-general/opencollectivites>`_ and is very much a work in progress. See the `documentation (in French) <https://entrepreneur-interet-general.github.io/django-dsfr/>`_ for details.

Django-DSFR (partly) implements the `version 1.1.0 of the DSFR <https://gouvfr.atlassian.net/wiki/spaces/DB/pages/806912001/Version+1.1.0>`_.

Requirements
------------
Tested with Python 3.8 and Django 3.2.5. Per `vermin <https://github.com/netromdk/vermin>`_, it should work with Python >= 3.0, and it should work with old versions of Django too.

Quick start
-----------

1. Install with :code:`pip install django-dsfr`.

2. Add "dsfr" to your INSTALLED_APPS setting like this, before the app you want to use it with::

    INSTALLED_APPS = [
        ...
        'dsfr',
        <your_app>
    ]

3. Include the tags in your base.html file::

    # <your_app>/templates/<your_app>/base.html
    {% load static dsfr_tags %}

    <!doctype html>
    <html lang="fr" data-fr-theme="default">
    <head>
      <meta charset="utf-8">
      <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">

      {% dsfr_css %}
      {% dsfr_favicon %}

      {% block extra_css %}{% endblock %}

      <title>MyApp</title>
    </head>

    <body>
      <main id="content">
        {% block custom_header %}
          {% include "dsfr/header.html" %}
        {% endblock %}
        {% dsfr_theme_modale %}

        {% block content %}{% endblock %}

        {% include "dsfr/footer.html" %}
      </main>

      {% dsfr_js %}
      {% block extra_js %}{% endblock %}
    </body>

    </html> 

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

