territories-dashboard-lib 0.1.3__tar.gz → 0.1.5__tar.gz

{territories_dashboard_lib-0.1.3/territories_dashboard_lib.egg-info → territories_dashboard_lib-0.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: territories-dashboard-lib
-Version: 0.1.3
+Version: 0.1.5
 Summary: Librairie pour la visualisation d'indicateurs territoriaux.
 Author-email: Bastien <bastien@prune.sh>
 License: LICENCE OUVERTE 2.0/OPEN LICENCE 2.0
@@ -85,20 +85,122 @@ Classifier: License :: Other/Proprietary License
 Requires-Python: >=3.13
 Description-Content-Type: text/markdown
 
-# territories-dashboard-lib
+# Tableau de bord des indicateurs territoriaux
 
-**Librairie Python pour créer rapidement un dashboard d'indicateurs territoriaux.**
+## Présentation
 
-Cette librairie permet d’analyser facilement des indicateurs sur un territoire donné, ou bien de se concentrer sur un indicateur spécifique pour une analyse détaillée.
+Bienvenue dans ce projet visant à faciliter la création de tableaux de bord territoriaux interactifs à partir de données d’indicateurs. Ce dispositif est composé de deux briques complémentaires :
 
-## ✨ Fonctionnalités
+### 1. `territories_dashboard_lib`
 
--   Création rapide de dashboards interactifs
--   Vue globale par territoire ou focus par indicateur
--   Pensée pour les projets liés à l’aménagement, à la planification ou à l’analyse territoriale
+Une **librairie Django** réutilisable, contenant des applications modulaires pour afficher rapidement un tableau de bord d'indicateurs territoriaux. Elle permet d’analyser des données à différentes mailles géographiques : nationale, régionale, départementale, et communale.  
+Elle comprend des fonctionnalités prêtes à l'emploi pour visualiser des données sur des thématiques comme la **mobilité durable**, la **rénovation énergétique** ou d'autres indicateurs liés au développement territorial.
 
-## 🔧 Installation
+### 2. `territories_dashboard_template`
 
-```bash
-pip install territories-dashboard-lib
+Un **template de projet Django clef en main**, conçu pour permettre à des équipes techniques de démarrer rapidement leur propre tableau de bord. Ce template utilise la librairie `territories_dashboard_lib` comme fondation.  
+Les utilisateurs peuvent cloner ce dépôt, l’adapter à leurs besoins, et configurer leur tableau de bord directement depuis l’interface d’administration (titre, organisme, pages de contenu statique, indicateurs à afficher...).
+
+Le template constitue un **point de départ standard**, mais n’impose aucune restriction technique en dehors du choix de Django comme framework. Les développeurs sont libres d'étendre ou de modifier les composants selon leurs besoins.
+
+### Prérequis
+
+Pour utiliser la librairie ou le template, vous devez disposer de :
+
+-   Une base de données PostgreSQL contenant les données des indicateurs territoriaux.
+-   Une capacité à déployer une application Django (hébergement, serveur web, etc.).
+
+Pour obtenir des informations détaillées sur les prérequis techniques ou les données :
+
+-   **Marina Ribeiro** – Directrice de projet Mission Connaissance  
+    marina.ribeiro@developpement-durable.gouv.fr
+-   **Louise Columelli** – ECOLAB  
+    louise.columelli@developpement-durable.gouv.fr
+-   **Olivier Rousseau** – Expert données  
+    olivier.rousseau@i-carre.net
+-   **Bastien** – Développeur web  
+    bastien@prune.sh
+
+### Exemples de projets utilisant ce dispositif
+
+-   [Tableau de bord des mobilités durables](https://mobilite-durable-tdb.din.developpement-durable.gouv.fr)
+-   [Boussole énergétique de la rénovation des logements](https://boussole-renovation.din.developpement-durable.gouv.fr)
+
+L’objectif de ce projet est d’**encourager la réutilisation** et l’**essaimage** de nouveaux tableaux de bord territoriaux, en mettant à disposition un socle technique commun, facilement adaptable et extensible.
+
+## Structure de la librairie
+
+La librairie est composée de plusieurs **applications Django** indépendantes et complémentaires :
+
+### `website_lib`
+
+Contient le code principal d’affichage des pages du tableau de bord :
+
+-   **Templates HTML Django** : dans `website_lib/templates`, organisés par page.
+-   **Fichiers statiques** (JS, CSS) : dans `website_lib/static`. Le JS est modulaire grâce à l’extension `.mjs`.
+-   **Vues Django** : dans `website_lib/views`, associées aux templates et fichiers statiques.
+
+### `tracking_lib`
+
+Gère le **tracking backend** : enregistrement en base de données des visites de pages, avec leurs paramètres (indicateur sélectionné, territoire, etc.) pour permettre des analyses d’usage.
+
+### `superset_lib`
+
+Permet d’**intégrer des dashboards Superset** dans les pages du site.  
+Superset est un outil permettant à des utilisateurs non techniques de construire des visualisations depuis une base de données.
+
+### `geo_lib`
+
+Permet d’**ajouter des couches géographiques** personnalisées (points, lignes, polygones) à la carte :
+
+-   Points : ex. stationnements vélo.
+-   Lignes : ex. pistes cyclables.
+-   Polygones : ex. zones ZFE.
+
+### `indicators_lib`
+
+Contient le code pour l’accès et la requête des **données d’indicateurs** dans la base PostgreSQL dédiée.
+
+### Composants React
+
+Certaines visualisations complexes sont développées en **React** (ex. cartes interactives, diagrammes de Sankey).
+
+-   Les composants sont dans `website_lib/react-components/`.
+-   Le bundling est effectué via **Webpack**
+-   Les composants React sont ensuite inclus dans les templates Django.
+-   `cd website_lib/react-components && npm install && npm run webpack`
+
+## Installation
+
+La librairie est publiée sur PyPI. Elle s’installe dans un projet Django via le package manager uv :
+
+`uv add territories_dashboard_lib`
+
+### Figer la version en production
+
+Pour éviter les mises à jour inattendues, il est conseillé de figer la version dans le fichier pyproject.toml :
+
+```
+# Par exemple :
+territories_dashboard_lib == 1.0.3
 ```
+
+### Développement local
+
+Pour tester une version locale de la librairie (ex : modifications en cours) :
+
+`uv add --editable ~/territories-dashboard/territories-dashboard-lib`
+
+## Publication PyPI
+
+Pour builder la librairie avant publication :
+
+`uv run python -m build`
+
+Pour déployer sur PyPI, vous devez :
+
+1. Avoir un compte PyPI.
+
+2. Être membre du projet sur PyPI.
+
+3. Lancer : `uv run twine upload dist/*`

territories_dashboard_lib-0.1.5/README.md

@@ -0,0 +1,119 @@
+# Tableau de bord des indicateurs territoriaux
+
+## Présentation
+
+Bienvenue dans ce projet visant à faciliter la création de tableaux de bord territoriaux interactifs à partir de données d’indicateurs. Ce dispositif est composé de deux briques complémentaires :
+
+### 1. `territories_dashboard_lib`
+
+Une **librairie Django** réutilisable, contenant des applications modulaires pour afficher rapidement un tableau de bord d'indicateurs territoriaux. Elle permet d’analyser des données à différentes mailles géographiques : nationale, régionale, départementale, et communale.  
+Elle comprend des fonctionnalités prêtes à l'emploi pour visualiser des données sur des thématiques comme la **mobilité durable**, la **rénovation énergétique** ou d'autres indicateurs liés au développement territorial.
+
+### 2. `territories_dashboard_template`
+
+Un **template de projet Django clef en main**, conçu pour permettre à des équipes techniques de démarrer rapidement leur propre tableau de bord. Ce template utilise la librairie `territories_dashboard_lib` comme fondation.  
+Les utilisateurs peuvent cloner ce dépôt, l’adapter à leurs besoins, et configurer leur tableau de bord directement depuis l’interface d’administration (titre, organisme, pages de contenu statique, indicateurs à afficher...).
+
+Le template constitue un **point de départ standard**, mais n’impose aucune restriction technique en dehors du choix de Django comme framework. Les développeurs sont libres d'étendre ou de modifier les composants selon leurs besoins.
+
+### Prérequis
+
+Pour utiliser la librairie ou le template, vous devez disposer de :
+
+-   Une base de données PostgreSQL contenant les données des indicateurs territoriaux.
+-   Une capacité à déployer une application Django (hébergement, serveur web, etc.).
+
+Pour obtenir des informations détaillées sur les prérequis techniques ou les données :
+
+-   **Marina Ribeiro** – Directrice de projet Mission Connaissance  
+    marina.ribeiro@developpement-durable.gouv.fr
+-   **Louise Columelli** – ECOLAB  
+    louise.columelli@developpement-durable.gouv.fr
+-   **Olivier Rousseau** – Expert données  
+    olivier.rousseau@i-carre.net
+-   **Bastien** – Développeur web  
+    bastien@prune.sh
+
+### Exemples de projets utilisant ce dispositif
+
+-   [Tableau de bord des mobilités durables](https://mobilite-durable-tdb.din.developpement-durable.gouv.fr)
+-   [Boussole énergétique de la rénovation des logements](https://boussole-renovation.din.developpement-durable.gouv.fr)
+
+L’objectif de ce projet est d’**encourager la réutilisation** et l’**essaimage** de nouveaux tableaux de bord territoriaux, en mettant à disposition un socle technique commun, facilement adaptable et extensible.
+
+## Structure de la librairie
+
+La librairie est composée de plusieurs **applications Django** indépendantes et complémentaires :
+
+### `website_lib`
+
+Contient le code principal d’affichage des pages du tableau de bord :
+
+-   **Templates HTML Django** : dans `website_lib/templates`, organisés par page.
+-   **Fichiers statiques** (JS, CSS) : dans `website_lib/static`. Le JS est modulaire grâce à l’extension `.mjs`.
+-   **Vues Django** : dans `website_lib/views`, associées aux templates et fichiers statiques.
+
+### `tracking_lib`
+
+Gère le **tracking backend** : enregistrement en base de données des visites de pages, avec leurs paramètres (indicateur sélectionné, territoire, etc.) pour permettre des analyses d’usage.
+
+### `superset_lib`
+
+Permet d’**intégrer des dashboards Superset** dans les pages du site.  
+Superset est un outil permettant à des utilisateurs non techniques de construire des visualisations depuis une base de données.
+
+### `geo_lib`
+
+Permet d’**ajouter des couches géographiques** personnalisées (points, lignes, polygones) à la carte :
+
+-   Points : ex. stationnements vélo.
+-   Lignes : ex. pistes cyclables.
+-   Polygones : ex. zones ZFE.
+
+### `indicators_lib`
+
+Contient le code pour l’accès et la requête des **données d’indicateurs** dans la base PostgreSQL dédiée.
+
+### Composants React
+
+Certaines visualisations complexes sont développées en **React** (ex. cartes interactives, diagrammes de Sankey).
+
+-   Les composants sont dans `website_lib/react-components/`.
+-   Le bundling est effectué via **Webpack**
+-   Les composants React sont ensuite inclus dans les templates Django.
+-   `cd website_lib/react-components && npm install && npm run webpack`
+
+## Installation
+
+La librairie est publiée sur PyPI. Elle s’installe dans un projet Django via le package manager uv :
+
+`uv add territories_dashboard_lib`
+
+### Figer la version en production
+
+Pour éviter les mises à jour inattendues, il est conseillé de figer la version dans le fichier pyproject.toml :
+
+```
+# Par exemple :
+territories_dashboard_lib == 1.0.3
+```
+
+### Développement local
+
+Pour tester une version locale de la librairie (ex : modifications en cours) :
+
+`uv add --editable ~/territories-dashboard/territories-dashboard-lib`
+
+## Publication PyPI
+
+Pour builder la librairie avant publication :
+
+`uv run python -m build`
+
+Pour déployer sur PyPI, vous devez :
+
+1. Avoir un compte PyPI.
+
+2. Être membre du projet sur PyPI.
+
+3. Lancer : `uv run twine upload dist/*`

{territories_dashboard_lib-0.1.3 → territories_dashboard_lib-0.1.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "territories-dashboard-lib"
-version = "0.1.3"
+version = "0.1.5"
 description = "Librairie pour la visualisation d'indicateurs territoriaux."
 authors = [
     { name = "Bastien", email = "bastien@prune.sh" }

{territories_dashboard_lib-0.1.3 → territories_dashboard_lib-0.1.5}/territories_dashboard_lib/indicators_lib/enums.py

@@ -1,3 +1,4 @@
+from django.conf import settings
 from django.db import models
 
 
@@ -57,3 +58,28 @@ MESH_DB = {
     MeshLevel.Epci: "EPCI",
     MeshLevel.Town: "DEPCOM",
 }
+
+
+def get_miminum_mesh():
+    try:
+        town_mesh_is_disabled = settings.DISABLE_TOWN_MESH
+        return MeshLevel.Epci if town_mesh_is_disabled else MeshLevel.Town
+    except AttributeError:
+        return MeshLevel.Town
+
+
+def get_allow_same_mesh():
+    try:
+        return bool(settings.ALLOW_SAME_MESH)
+    except AttributeError:
+        return False
+
+
+def get_all_meshes():
+    min_mesh = get_miminum_mesh()
+    meshes = []
+    for m in MeshLevel:
+        meshes.append(m)
+        if m == min_mesh:
+            break
+    return meshes

{territories_dashboard_lib-0.1.3 → territories_dashboard_lib-0.1.5}/territories_dashboard_lib/indicators_lib/export.py

@@ -2,14 +2,14 @@ import csv
 
 from django.http import HttpRequest, HttpResponse
 
-from territories_dashboard_lib.tracking_lib.enums import EventType
+from territories_dashboard_lib.tracking_lib.enums import EventType, GraphType
 from territories_dashboard_lib.tracking_lib.logic import track_event
 
 from .models import Indicator
 
 
 def export_to_csv(
-    request: HttpRequest, indicator: Indicator, graph_name: str, data: list[dict]
+    request: HttpRequest, indicator: Indicator, graph_name: GraphType, data: list[dict]
 ):
     response = HttpResponse(content_type="text/csv")
     response["Content-Disposition"] = (
@@ -24,6 +24,6 @@ def export_to_csv(
         request=request,
         response=response,
         event_name=EventType.download,
-        data={"indicator": indicator.name, "objet": graph_name},
+        data={"indicator": indicator.name, "objet": graph_name, "type": "csv"},
     )
     return response

territories_dashboard_lib-0.1.5/territories_dashboard_lib/indicators_lib/migrations/0002_filter_color_indicator_min_mesh_and_more.py

@@ -0,0 +1,28 @@
+# Generated by Django 5.2.3 on 2025-06-19 12:59
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('indicators_lib', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='filter',
+            name='color',
+            field=models.TextField(blank=True, help_text='format hexadécimale : #FF11DD', null=True, verbose_name='Couleur'),
+        ),
+        migrations.AddField(
+            model_name='indicator',
+            name='min_mesh',
+            field=models.TextField(choices=[('fr', 'National'), ('reg', 'Region'), ('dep', 'Department'), ('epci', 'Epci'), ('com', 'Town')], default='com'),
+        ),
+        migrations.AlterField(
+            model_name='indicator',
+            name='show_evolution',
+            field=models.BooleanField(default=True),
+        ),
+    ]

{territories_dashboard_lib-0.1.3 → territories_dashboard_lib-0.1.5}/territories_dashboard_lib/indicators_lib/models.py

@@ -2,7 +2,10 @@ from django.db import models
 from martor.models import MartorField
 
 from territories_dashboard_lib.commons.models import CommonModel
-from territories_dashboard_lib.indicators_lib.enums import AggregationFunctions
+from territories_dashboard_lib.indicators_lib.enums import (
+    AggregationFunctions,
+    MeshLevel,
+)
 from territories_dashboard_lib.indicators_lib.refresh_filters import refresh_filters
 
 
@@ -101,6 +104,7 @@ class Indicator(CommonModel):
     # Indicator's DB attributes
     db_table_prefix = models.CharField(max_length=128)
     db_table_prefix.verbose_name = "Préfixe dans la DB"
+    min_mesh = models.TextField(choices=MeshLevel.choices, default=MeshLevel.Town)
     is_composite = models.BooleanField(default=False)
     is_composite.verbose_name = "Indicateur composite"
     show_alternative = models.BooleanField(
@@ -158,7 +162,7 @@ class Indicator(CommonModel):
         help_text="Nom de la colonne des dimensions de la table des flux",
     )
     # Descriptive attributes
-    show_evolution = models.BooleanField(default=False)
+    show_evolution = models.BooleanField(default=True)
     show_evolution.verbose_name = "Activer l'historique"
     source = models.TextField(default="", blank=True)
     description = models.TextField(default="", blank=True)
@@ -216,6 +220,12 @@ class Filter(CommonModel):
     order.verbose_name = "Ordre"
     default = models.BooleanField(default=True)
     default.verbose_name = "Sélectionné par défaut ?"
+    color = models.TextField(
+        null=True,
+        blank=True,
+        verbose_name="Couleur",
+        help_text="format hexadécimale : #FF11DD",
+    )
 
     def __str__(self):
         return self.db_name

{territories_dashboard_lib-0.1.3 → territories_dashboard_lib-0.1.5}/territories_dashboard_lib/indicators_lib/query/commons.py

@@ -1,4 +1,10 @@
-from ..enums import DEFAULT_MESH, FRANCE_DB_VALUES, GeoLevel, MeshLevel
+from ..enums import (
+    DEFAULT_MESH,
+    FRANCE_DB_VALUES,
+    GeoLevel,
+    MeshLevel,
+    get_miminum_mesh,
+)
 from ..models import AggregationFunctions, Indicator
 from .utils import get_breakdown_dimension, run_custom_query
 
@@ -156,7 +162,7 @@ def get_mesh_level_for_geo_level(mesh, submesh):
             else submesh
         )
     elif mesh in [GeoLevel.Epci, GeoLevel.Town]:
-        return MeshLevel.Town
+        return get_miminum_mesh()
     else:
         return submesh or DEFAULT_MESH
 

{territories_dashboard_lib-0.1.3 → territories_dashboard_lib-0.1.5}/territories_dashboard_lib/indicators_lib/query/details.py

@@ -14,21 +14,27 @@ from .utils import get_breakdown_dimension, run_custom_query
 def get_proportions_chart(indicator, territory, filters):
     where_territory = get_where_territory(territory)
     last_year = get_last_year(indicator, territory.mesh)
-    breakdown_dimension = get_breakdown_dimension(indicator).db_name
+    breakdown_dimension = get_breakdown_dimension(indicator)
 
     query = f"""
-    SELECT {calculate_aggregate_values(indicator, with_alternative=False)}, "{breakdown_dimension}" as dimension
+    SELECT {calculate_aggregate_values(indicator, with_alternative=False)}, "{breakdown_dimension.db_name}" as dimension
     FROM "{indicator.db_table_prefix}_{territory.mesh}" as indic
     WHERE {where_territory} AND annee = {last_year}
     {add_optional_filters(indicator, filters)}
-    GROUP BY "{breakdown_dimension}"
+    GROUP BY "{breakdown_dimension.db_name}"
 """
 
     data = run_custom_query(query)
+    filters_color = {f.db_name: f.color for f in breakdown_dimension.filters.all()}
     data_dict = {
-        d["dimension"]: {"label": d["dimension"], "data": [d["valeur"]]} for d in data
+        d["dimension"]: {
+            "label": d["dimension"],
+            "data": [d["valeur"]],
+            "color": filters_color.get(d["dimension"]),
+        }
+        for d in data
     }
-    breakdown_filters = filters[breakdown_dimension]
+    breakdown_filters = filters[breakdown_dimension.db_name]
     sorted_data = (
         [data_dict[filter] for filter in breakdown_filters if filter in data_dict]
         if filters

{territories_dashboard_lib-0.1.3 → territories_dashboard_lib-0.1.5}/territories_dashboard_lib/indicators_lib/query/top_10.py

@@ -47,8 +47,10 @@ def get_indicator_top_10_data(indicator, territory, submesh, filters):
     indicator_details = {}
 
     breakdown_dimension = get_breakdown_dimension(indicator)
-    breakdown_dimension = breakdown_dimension.db_name if breakdown_dimension else None
-    breakdown_filters = filters.get(breakdown_dimension, [])
+    breakdown_dimension_name = (
+        breakdown_dimension.db_name if breakdown_dimension else None
+    )
+    breakdown_filters = filters.get(breakdown_dimension_name, [])
 
     last_year = get_last_year(indicator, submesh)
 
@@ -63,6 +65,7 @@ def get_indicator_top_10_data(indicator, territory, submesh, filters):
         breakdown_by_geocode = defaultdict(dict)
         for row in breakdown:
             breakdown_by_geocode[row["code_geo"]][row["dimension"]] = row["valeur"]
+        filters_color = {f.db_name: f.color for f in breakdown_dimension.filters.all()}
         datasets_top_bar_chart = [
             {
                 "label": f,
@@ -70,6 +73,7 @@ def get_indicator_top_10_data(indicator, territory, submesh, filters):
                     breakdown_by_geocode[territory["code_geo"]][f]
                     for territory in territories
                 ],
+                "color": filters_color.get(f),
             }
             for f in breakdown_filters
         ]

{territories_dashboard_lib-0.1.3 → territories_dashboard_lib-0.1.5}/territories_dashboard_lib/indicators_lib/refresh_filters.py

@@ -7,7 +7,7 @@ def refresh_filters(dimension):
     if dimension:
         query = f'SELECT DISTINCT({dimension.db_name}) as filter FROM "{dimension.indicator.db_table_prefix}_reg"'
         results = run_custom_query(query)
-        Filter = apps.get_model("tdbmd_indicators", "Filter")
+        Filter = apps.get_model("indicators_lib", "Filter")
         Filter.objects.filter(dimension=dimension).delete()
         Filter.objects.bulk_create(
             [

{territories_dashboard_lib-0.1.3 → territories_dashboard_lib-0.1.5}/territories_dashboard_lib/indicators_lib/views.py

@@ -6,7 +6,7 @@ from django.views.decorators.cache import cache_control
 from django.views.decorators.http import require_GET
 
 from territories_dashboard_lib.commons.decorators import use_payload
-from territories_dashboard_lib.tracking_lib.enums import EventType
+from territories_dashboard_lib.tracking_lib.enums import EventType, GraphType
 from territories_dashboard_lib.tracking_lib.logic import track_event
 
 from .enums import MESH_TITLES
@@ -54,7 +54,7 @@ def download_indicator_methodo_view(request, name):
         request=request,
         response=response,
         event_name=EventType.download,
-        data={"indicator": indicator.name, "objet": "methodo"},
+        data={"indicator": indicator.name, "objet": "methodo", "type": "pdf"},
     )
     return response
 
@@ -129,14 +129,16 @@ def indicator_values_export_view(request, name, payload):
             "Année": value["annee"],
             f"Valeur {territory_name} ({indicator.unite})": value["valeur"],
         }
+    tracking_objet = "historique"
     if results.get("cmp_values") is not None:
         cmp_territory_name = get_territory_name(payload.cmp_territory)
         for value in results["cmp_values"]:
             export_values[value["annee"]][
                 f"Valeur {cmp_territory_name} ({indicator.unite})"
             ] = value["valeur"]
+        tracking_objet = "comparaison-" + tracking_objet
     return export_to_csv(
-        request, indicator, "comparaison-historique", list(export_values.values())
+        request, indicator, tracking_objet, list(export_values.values())
     )
 
 
@@ -183,7 +185,7 @@ def indicator_proportions_export_view(request, name, payload):
         {"Dimension": r["label"], f"Valeur {indicator.unite}": r["data"][0]}
         for r in rows
     ]
-    return export_to_csv(request, indicator, "repartition-dimension", rows)
+    return export_to_csv(request, indicator, GraphType.repartition_dimension, rows)
 
 
 @cache_control(max_age=3600)
@@ -227,7 +229,7 @@ def indicator_histogram_export_view(request, name, payload):
             index
         ].replace("\n", " | ")
         rows.append(row)
-    return export_to_csv(request, indicator, "repartition-valeurs", rows)
+    return export_to_csv(request, indicator, GraphType.repartition_valeurs, rows)
 
 
 @cache_control(max_age=3600)
@@ -255,7 +257,7 @@ def indicator_top_10_export_view(request, name, payload):
         payload.submesh,
         filters,
     )
-    return export_to_csv(request, indicator, "top_10", csv_data)
+    return export_to_csv(request, indicator, GraphType.top_10, csv_data)
 
 
 @require_GET
@@ -404,7 +406,7 @@ def comparison_histogram_export_view(request, name, payload):
             cmp_values[index + 1][:10]
         )
         rows.append(row)
-    return export_to_csv(request, indicator, "comparison-histogram", rows)
+    return export_to_csv(request, indicator, GraphType.comparison_histogram, rows)
 
 
 def get_label(props, indicator, key):
@@ -487,4 +489,4 @@ def indicator_details_table_export_view(request, name, payload):
     indicator = get_object_or_404(Indicator, name=name)
     filters = get_filters(request, indicator)
     table_values = get_export_indicator_table_values(indicator, payload, filters)
-    return export_to_csv(request, indicator, "table", table_values)
+    return export_to_csv(request, indicator, GraphType.table, table_values)

territories_dashboard_lib-0.1.5/territories_dashboard_lib/tracking_lib/enums.py

@@ -0,0 +1,17 @@
+from django.db import models
+
+TRACKING_COOKIE_NAME = "omnibus"
+
+
+class EventType(models.TextChoices):
+    download = "download"
+
+
+class GraphType(models.TextChoices):
+    comparaison_historique = "comparaison-historique"
+    repartition_dimension = "repartition-dimension"
+    repartition_valeurs = "repartition-valeurs"
+    top_10 = "top_10"
+    historique = "historique"
+    comparison_histogram = "comparison-histogram"
+    table = "table"

territories_dashboard_lib-0.1.5/territories_dashboard_lib/tracking_lib/payloads.py

@@ -0,0 +1,10 @@
+from pydantic import BaseModel
+
+from territories_dashboard_lib.tracking_lib.enums import EventType
+
+
+class EventPayload(BaseModel):
+    indicator: str
+    event: EventType
+    objet: str
+    type: str

territories_dashboard_lib-0.1.5/territories_dashboard_lib/tracking_lib/urls.py

@@ -0,0 +1,9 @@
+from django.urls import path
+
+from territories_dashboard_lib.tracking_lib.views import track_event_view
+
+app_name = "tracking-api"
+
+urlpatterns = [
+    path("event/", track_event_view, name="event"),
+]

territories_dashboard_lib-0.1.5/territories_dashboard_lib/tracking_lib/views.py

@@ -0,0 +1,43 @@
+import json
+from datetime import timedelta
+
+from django.http import HttpResponse, JsonResponse
+from django.utils import timezone
+from django.views.decorators.csrf import csrf_exempt
+from django.views.decorators.http import require_POST
+from pydantic import ValidationError
+
+from territories_dashboard_lib.tracking_lib.logic import (
+    track_event,
+)
+from territories_dashboard_lib.tracking_lib.models import Event
+from territories_dashboard_lib.tracking_lib.payloads import EventPayload
+
+
+@require_POST
+@csrf_exempt
+def track_event_view(request):
+    try:
+        data = json.loads(request.body)
+        payload = EventPayload(**data)
+    except json.JSONDecodeError:
+        return JsonResponse({"error": "Invalid JSON"}, status=400)
+    except ValidationError as e:
+        return JsonResponse({"error": e.errors()}, status=422)
+    if (
+        Event.objects.filter(created_at__gte=timezone.now() - timedelta(days=1)).count()
+        > 1000
+    ):
+        return HttpResponse(status=429)
+    response = HttpResponse()
+    track_event(
+        request=request,
+        response=response,
+        event_name=payload.event,
+        data={
+            "indicator": payload.indicator,
+            "objet": payload.objet,
+            "type": payload.type,
+        },
+    )
+    return HttpResponse()