Skip to content

Commit

Permalink
Replace RST readme file with a MD version (#180)
Browse files Browse the repository at this point in the history
* Replace RST readme file with a MD version

* Update twine
  • Loading branch information
Ash-Crow authored Oct 16, 2024
1 parent 9c631fd commit 46ec7f5
Show file tree
Hide file tree
Showing 4 changed files with 82 additions and 82 deletions.
68 changes: 68 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
[![image](https://img.shields.io/github/v/release/numerique-gouv/django-dsfr.svg)](https://github.com/numerique-gouv/django-dsfr/releases/)

[![image](https://badge.fury.io/py/django-dsfr.svg)](https://pypi.org/project/django-dsfr/)

[![image](https://github.com/numerique-gouv/django-dsfr/actions/workflows/ci-3-8.yml/badge.svg)](https://github.com/numerique-gouv/django-dsfr/actions/workflows/ci-3-8.yml)

[![image](https://github.com/numerique-gouv/django-dsfr/actions/workflows/ci-3-10.yml/badge.svg)](https://github.com/numerique-gouv/django-dsfr/actions/workflows/ci-3-10.yml)

[![image](https://github.com/numerique-gouv/django-dsfr/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/numerique-gouv/django-dsfr/actions/workflows/codeql-analysis.yml)

[![Security Status](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)

# 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/).

## Documentation

See the [documentation (in French)](https://numerique-gouv.github.io/django-dsfr/) for details.

Django-DSFR implements the [version 1.12.1 of the DSFR](https://www.systeme-de-design.gouv.fr/a-propos/versions/version-courante)
(see also the [Github releases page](https://github.com/GouvernementFR/dsfr/releases/))

## Requirements

Tested with Python 3.8 to 3.12 and Django 3.2 to 5.0. Per [vermin](https://github.com/netromdk/vermin), it should work with Python >= 3.6, and it should work with old versions of Django too.

Note: Only supported versions of Django and Python are supported by this project. You can check the supported versions and their end of life on the following pages:

- [Python](https://devguide.python.org/versions/)
- [Django](https://www.djangoproject.com/download/#supported-versions)

⚠️ Warning: Support for Django < 4.0 and Python < 3.10 will be removed at the end of 2024.

## Quick start

See the [INSTALL.md](INSTALL.md) file.

## History

This app was originally created as a part of [Open
Collectivités](https://github.com/entrepreneur-interet-general/opencollectivites)
in 2020, and then maintained as part of
[Aides-territoires](https://github.com/MTES-MCT/aides-territoires) in
2022-2023.

It is now maintained as part of
[\@numerique-gouv](https://github.com/numerique-gouv) alongside the
Wagtail-based [Sites
faciles](https://github.com/numerique-gouv/sites-faciles).

## Licence et droit d’utilisation

Le contenu de ce projet est placé sous licence MIT, à l’exception de la
fonte Marianne. Voir [la licence du
DSFR](https://github.com/GouvernementFR/dsfr/blob/main/doc/legal/cgu.md).

### ⚠️ Utilisation du DSFR interdite en dehors des sites Internet de l’État

> Il est formellement interdit à tout autre acteur d’utiliser le Système de Design de l’État (les administrations territoriales ou tout autre acteur privé) pour des sites web ou des applications. Le Système de Design de l’État représente l’identité numérique de l’État. En cas d’usage à des fins trompeuses ou frauduleuses, l’État se réserve le droit d’entreprendre les actions nécessaires pour y mettre un terme.
>
> Voir les [conditions générales d’utilisation](https://github.com/GouvernementFR/dsfr/blob/main/doc/legal/cgu.md).
### ⚠️ Prohibited Use Outside Government Websites

> This Design System is only meant to be used by official French public
> services\' websites and apps. Its main purpose is to make it easy to
> identify governmental websites for citizens. See terms.
68 changes: 0 additions & 68 deletions README.rst

This file was deleted.

20 changes: 10 additions & 10 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ authors = ["Sylvain Boissel <[email protected]>"]
description = "Integrate the French government Design System into a Django app"
license = "MIT"
name = "django-dsfr"
version = "1.4.0"
version = "1.4.1"
classifiers = [
"Development Status :: 5 - Production/Stable",
"Environment :: Web Environment",
Expand All @@ -29,14 +29,14 @@ classifiers = [
documentation = "https://numerique-gouv.github.io/django-dsfr"
homepage = "https://github.com/numerique-gouv/django-dsfr"
keywords = ["django"]
readme = "README.rst"
readme = "README.md"
repository = "https://github.com/numerique-gouv/django-dsfr"

packages = [
{include = "dsfr"},
]

include = ["LICENSE", "README.rst", "dsfr/static/dsfr/dist/*/*.*"]
include = ["LICENSE", "README.md", "dsfr/static/dsfr/dist/*/*.*"]

[tool.poetry.dependencies]
Django = ">3.2.5"
Expand All @@ -50,7 +50,6 @@ coverage = "^5.5"
django-distill = "^2.9.0"
docutils = "^0.17.1"
pytest = "^7.2.0"
twine = "^4.0.1"
djlint = "^1.12.0"
black = ">=22.6,<25.0"
django-csp = "^3.7"
Expand All @@ -63,6 +62,7 @@ pygments = "^2.16.1"
beautifulsoup4 = "^4.12.2"
lxml = "^5.1.0"
setuptools = "^70.0.0"
twine = "^5.1.1"

[build-system]
build-backend = "poetry.core.masonry.api"
Expand Down

0 comments on commit 46ec7f5

Please sign in to comment.