territories-dashboard-lib 0.1.0__py3-none-any.whl → 0.1.2__py3-none-any.whl

territories_dashboard_lib/superset_lib/models.py

@@ -0,0 +1,52 @@
+from django.db import models
+
+from territories_dashboard_lib.commons.models import CommonModel
+from territories_dashboard_lib.indicators_lib.enums import MeshLevel
+
+
+class Dashboard(CommonModel):
+    superset_id = models.TextField(
+        unique=True,
+        verbose_name="Embed ID de Superset",
+        help_text="Un utilisateur administrateur de l'instance Superset doit accéder aux paramètres du dashboard et cliquer sur 'embed dashboard' pour récupérer cet ID nécessaire à la connexion avec l'instance Superset.",
+    )
+    short_name = models.TextField(
+        unique=True,
+        verbose_name="Nom court",
+        help_text="Pour l'URL, ne mettre que des lettres minuscules sans accents et des tirets",
+    )
+    label = models.TextField(
+        unique=True,
+        verbose_name="Label",
+        help_text="Nom du dashboard à afficher dans la liste.",
+    )
+    order = models.IntegerField(
+        default=1,
+        verbose_name="Numéro d'ordre",
+        help_text="Numéro d'ordre dans la dropdown de sélection, les dashboards sont triés du plus petit numéro au plus grand.",
+    )
+
+    def __str__(self):
+        return self.label
+
+
+class Filter(CommonModel):
+    dashboard = models.ForeignKey(
+        Dashboard, on_delete=models.CASCADE, related_name="filters"
+    )
+    superset_id = models.TextField(
+        null=True,
+        blank=True,
+        help_text="ID du native filter du territoire, qui permettra d'initialiser les filtres du dasbhoard au territoire sélectionné dans l'application. Pour le récupérer c'est un petit parcours du combattant : aller sur le dashboard dans superset, cliquer sur modifier le dashboard, cliquer sur les trois petits points, puis sur modifier les propriétés. Cliquer sur avancé, copier le json et le coller dans un site comme : https://jsonformatter.curiousconcept.com/ pour mieux le voir. Chercher 'global_chart_configuration' puis 'native_filter_configuration'. Chercher le native filter lié au choix du territoire. Copier l'id qui dans son nom, le nom est de la forme NATIVE_FILTER-ID. Promis, c'est le plus simple que j'ai trouvé !",
+    )
+    superset_col = models.TextField(
+        null=True,
+        blank=True,
+        help_text="Nom de la colonne en base de données liée au filtre sur le territoire. Pour trouver le nom faire les mêmes étapes que pour geo_filter_id et chercher 'column' dans les paramètres json du native filter.",
+    )
+    mesh = models.TextField(
+        choices=MeshLevel.choices,
+        null=True,
+        blank=True,
+        help_text="Maille du territoire sur lequel s'effectue le filtre.",
+    )

territories_dashboard_lib/superset_lib/serializers.py

@@ -0,0 +1,10 @@
+from .models import Dashboard
+
+
+def serialize_dashboard(dashboard: Dashboard):
+    return {
+        "id": dashboard.id,
+        "superset_id": dashboard.superset_id,
+        "label": dashboard.label,
+        "short_name": dashboard.short_name,
+    }

territories_dashboard_lib/superset_lib/urls.py

@@ -0,0 +1,10 @@
+from django.urls import path
+
+from .views import dashboards_view, guest_token_view
+
+app_name = "superset-api"
+
+urlpatterns = [
+    path("guest-token/", guest_token_view, name="guest-token"),
+    path("dashboards/", dashboards_view, name="dashboards"),
+]

territories_dashboard_lib/superset_lib/views.py

@@ -0,0 +1,19 @@
+from django.http import HttpResponse, JsonResponse
+from django.views.decorators.http import require_GET
+
+from .guest_token import get_guest_token
+from .models import Dashboard
+
+
+@require_GET
+def guest_token_view(request):
+    dashboard_id = request.GET.get("dashboard")
+    guest_token = get_guest_token(dashboard_id)
+    return HttpResponse(guest_token)
+
+
+@require_GET
+def dashboards_view(request):
+    dashboards = Dashboard.objects.order_by("order", "label")
+    data = [{"label": d.label, "superset_id": d.superset_id} for d in dashboards]
+    return JsonResponse(data, safe=False)

territories_dashboard_lib/tracking_lib/enums.py

@@ -0,0 +1,7 @@
+from django.db import models
+
+TRACKING_COOKIE_NAME = "omnibus"
+
+
+class EventType(models.TextChoices):
+    download = "download"

territories_dashboard_lib/tracking_lib/logic.py

@@ -0,0 +1,78 @@
+import uuid
+from datetime import timedelta
+from typing import TYPE_CHECKING, Union
+
+from django.http import HttpRequest, HttpResponse
+from django.urls import resolve
+
+from territories_dashboard_lib.tracking_lib.enums import TRACKING_COOKIE_NAME, EventType
+from territories_dashboard_lib.tracking_lib.models import Event, Page
+
+if TYPE_CHECKING:
+    from territories_dashboard_lib.indicators_lib.models import Indicator, Theme
+
+
+def get_or_set_tracking_cookie(request: HttpRequest, response: HttpResponse) -> str:
+    tracking_cookie = request.COOKIES.get(TRACKING_COOKIE_NAME)
+    if tracking_cookie is None:
+        tracking_cookie = str(uuid.uuid4())
+        response.set_cookie(
+            key=TRACKING_COOKIE_NAME,
+            value=tracking_cookie,
+            max_age=timedelta(days=365),
+        )
+    return tracking_cookie
+
+
+def track_page(
+    *,
+    request: HttpRequest,
+    response: HttpResponse,
+    params=None,
+    indicator: Union["Indicator", None] = None,
+    theme: Union["Theme", None] = None,
+):
+    if params is None:
+        params = {}
+    try:
+        cookie = get_or_set_tracking_cookie(request, response)
+        match = resolve(request.path)
+        view_name = match.view_name
+        Page.objects.create(
+            cookie=cookie,
+            territory_id=params.get("territory_id"),
+            territory_mesh=params.get("territory_mesh"),
+            submesh=params.get("mesh"),
+            cmp_territory_id=params.get("cmp_territory_id"),
+            cmp_territory_mesh=params.get("cmp_territory_mesh"),
+            indicator=indicator.id if indicator else None,
+            indicator_name=indicator.name if indicator else None,
+            theme=theme.id if theme else None,
+            theme_name=theme.name if theme else None,
+            url=request.get_full_path(),
+            view=view_name,
+        )
+    except Exception as e:
+        print("error while tracking indicator view")
+        print(e)
+    return response
+
+
+def track_event(
+    *, request: HttpRequest, response: HttpResponse, event_name=EventType, data
+):
+    try:
+        cookie = get_or_set_tracking_cookie(request, response)
+        match = resolve(request.path)
+        view_name = match.view_name
+        Event.objects.create(
+            cookie=cookie,
+            name=event_name,
+            data=data,
+            url=request.get_full_path(),
+            view=view_name,
+        )
+    except Exception as e:
+        print("error while tracking event")
+        print(e)
+    return response

territories_dashboard_lib/tracking_lib/migrations/0001_initial.py

@@ -0,0 +1,45 @@
+# Generated by Django 5.2.3 on 2025-06-18 13:03
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Event',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('created_at', models.DateTimeField(auto_now_add=True)),
+                ('cookie', models.TextField(help_text="Un cookie sans durée d'expiration est placé dans chaque nouvelle session, il possède une valeur aléatoire qui permet de tracer le navigateur du visiteur entre plusieurs visites.")),
+                ('name', models.TextField(choices=[('download', 'Download')])),
+                ('data', models.JSONField(blank=True, null=True)),
+                ('url', models.TextField(help_text='URL brut de la page')),
+                ('view', models.TextField(help_text='Nom de la vue dans Django')),
+            ],
+        ),
+        migrations.CreateModel(
+            name='Page',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('created_at', models.DateTimeField(auto_now_add=True)),
+                ('cookie', models.TextField(help_text="Un cookie sans durée d'expiration est placé dans chaque nouvelle session, il possède une valeur aléatoire qui permet de tracer le navigateur du visiteur entre plusieurs visites.")),
+                ('territory_id', models.TextField(blank=True, help_text='ID du territoire principal sélectionné.', null=True)),
+                ('territory_mesh', models.TextField(blank=True, choices=[('fr', 'National'), ('reg', 'Region'), ('dep', 'Department'), ('epci', 'Epci'), ('com', 'Town')], help_text='Maille du territoire principal sélectionné.', null=True)),
+                ('submesh', models.TextField(blank=True, choices=[('fr', 'National'), ('reg', 'Region'), ('dep', 'Department'), ('epci', 'Epci'), ('com', 'Town')], help_text="Maille d'analyse sélectionnée.", null=True)),
+                ('cmp_territory_id', models.TextField(blank=True, help_text="ID du territoire de comparaison, null s'il ne s'agit pas de la page comparaison.", null=True)),
+                ('cmp_territory_mesh', models.TextField(blank=True, choices=[('fr', 'National'), ('reg', 'Region'), ('dep', 'Department'), ('epci', 'Epci'), ('com', 'Town')], help_text="Maille du territoire de comparaison, null s'il ne s'agit pas de la page comparaison.", null=True)),
+                ('indicator', models.IntegerField(blank=True, help_text="ID de l'indicateur de la page détails, null s'il ne s'agit pas de la page détails, utile pour faire des jointures.", null=True)),
+                ('indicator_name', models.TextField(blank=True, help_text="Nom de l'indicateur de la page détails, null s'il ne s'agit pas de la page détails, utile pour une analyse rapide.", null=True)),
+                ('theme', models.IntegerField(blank=True, help_text='ID du thème de la page, utile pour faire des jointures.', null=True)),
+                ('theme_name', models.TextField(blank=True, help_text='Nom du thème de la page, utile pour une analyse rapide.', null=True)),
+                ('url', models.TextField(help_text='URL brut de la page')),
+                ('view', models.TextField(help_text='Nom de la vue dans Django')),
+            ],
+        ),
+    ]

territories_dashboard_lib/tracking_lib/models.py

@@ -0,0 +1,79 @@
+from django.db import models
+
+from territories_dashboard_lib.indicators_lib.enums import MeshLevel
+from territories_dashboard_lib.tracking_lib.enums import EventType
+
+
+class Page(models.Model):
+    """
+    Une vue correspond à l'ouverture d'une des pages de l'application.
+    À chaque changement de paramètre (territoire, maille, territoire de comparaison) une nouvelle vue est enregistrée.
+    """
+
+    created_at = models.DateTimeField(auto_now_add=True)
+    cookie = models.TextField(
+        help_text="Un cookie sans durée d'expiration est placé dans chaque nouvelle session, il possède une valeur aléatoire qui permet de tracer le navigateur du visiteur entre plusieurs visites."
+    )
+    territory_id = models.TextField(
+        help_text="ID du territoire principal sélectionné.", null=True, blank=True
+    )
+    territory_mesh = models.TextField(
+        choices=MeshLevel.choices,
+        help_text="Maille du territoire principal sélectionné.",
+        null=True,
+        blank=True,
+    )
+    submesh = models.TextField(
+        choices=MeshLevel.choices,
+        help_text="Maille d'analyse sélectionnée.",
+        null=True,
+        blank=True,
+    )
+    cmp_territory_id = models.TextField(
+        null=True,
+        blank=True,
+        help_text="ID du territoire de comparaison, null s'il ne s'agit pas de la page comparaison.",
+    )
+    cmp_territory_mesh = models.TextField(
+        choices=MeshLevel.choices,
+        null=True,
+        blank=True,
+        help_text="Maille du territoire de comparaison, null s'il ne s'agit pas de la page comparaison.",
+    )
+    indicator = models.IntegerField(
+        null=True,
+        blank=True,
+        help_text="ID de l'indicateur de la page détails, null s'il ne s'agit pas de la page détails, utile pour faire des jointures.",
+    )
+    indicator_name = models.TextField(
+        null=True,
+        blank=True,
+        help_text="Nom de l'indicateur de la page détails, null s'il ne s'agit pas de la page détails, utile pour une analyse rapide.",
+    )
+    theme = models.IntegerField(
+        help_text="ID du thème de la page, utile pour faire des jointures.",
+        null=True,
+        blank=True,
+    )
+    theme_name = models.TextField(
+        help_text="Nom du thème de la page, utile pour une analyse rapide.",
+        null=True,
+        blank=True,
+    )
+    url = models.TextField(help_text="URL brut de la page")
+    view = models.TextField(help_text="Nom de la vue dans Django")
+
+
+class Event(models.Model):
+    """
+    Tracking des autres événements de l'application
+    """
+
+    created_at = models.DateTimeField(auto_now_add=True)
+    cookie = models.TextField(
+        help_text="Un cookie sans durée d'expiration est placé dans chaque nouvelle session, il possède une valeur aléatoire qui permet de tracer le navigateur du visiteur entre plusieurs visites."
+    )
+    name = models.TextField(choices=EventType.choices)
+    data = models.JSONField(null=True, blank=True)
+    url = models.TextField(help_text="URL brut de la page")
+    view = models.TextField(help_text="Nom de la vue dans Django")

territories_dashboard_lib/website_lib/admin.py

@@ -0,0 +1,40 @@
+from django.contrib import admin
+
+from territories_dashboard_lib.website_lib.forms import (
+    GlossaryItemAdminForm,
+    LandingPageAdminForm,
+    MainConfAdminForm,
+    StaticPageAdminForm,
+)
+from territories_dashboard_lib.website_lib.models import (
+    GlossaryItem,
+    LandingPage,
+    MainConf,
+    NoticeBanner,
+    StaticPage,
+)
+
+
+@admin.register(MainConf)
+class MainConfAdmin(admin.ModelAdmin):
+    form = MainConfAdminForm
+
+
+@admin.register(GlossaryItem)
+class GlossaryItemAdmin(admin.ModelAdmin):
+    form = GlossaryItemAdminForm
+
+
+@admin.register(LandingPage)
+class LandingPageAdminForm(admin.ModelAdmin):
+    form = LandingPageAdminForm
+
+
+@admin.register(StaticPage)
+class StaticPageAdminForm(admin.ModelAdmin):
+    form = StaticPageAdminForm
+
+
+@admin.register(NoticeBanner)
+class NoticeBannerAdmin(admin.ModelAdmin):
+    list_display = ("title", "created_at")

territories_dashboard_lib/website_lib/context_processors.py

@@ -0,0 +1,27 @@
+from django.conf import settings
+
+from territories_dashboard_lib.superset_lib.models import Dashboard
+from territories_dashboard_lib.superset_lib.serializers import serialize_dashboard
+from territories_dashboard_lib.website_lib.models import (
+    MainConf,
+    NoticeBanner,
+)
+
+
+def default(request):
+    main_conf = MainConf.objects.first()
+    notice = NoticeBanner.objects.first()
+    context = {
+        "ENABLE_SUPERSET": settings.ENABLE_SUPERSET,
+        "ANALYTICS_ID": settings.ANALYTICS_ID,
+        "ENVIRONMENT": settings.ENVIRONMENT,
+        "view_name": request.resolver_match.view_name,
+        "main_conf": main_conf,
+        "notice": notice,
+        "dashboards": [
+            serialize_dashboard(d)
+            for d in Dashboard.objects.all().order_by("order", "label")
+        ],
+        "version": settings.VERSION,
+    }
+    return context

territories_dashboard_lib/website_lib/forms.py

@@ -0,0 +1,47 @@
+from django import forms
+from django.forms import Textarea
+
+from territories_dashboard_lib.website_lib.models import (
+    GlossaryItem,
+    LandingPage,
+    MainConf,
+    StaticPage,
+)
+
+
+class MainConfAdminForm(forms.ModelForm):
+    class Meta:
+        model = MainConf
+        fields = "__all__"
+        widgets = {
+            "title": Textarea(attrs={"rows": 1, "cols": 30}),
+        }
+
+
+class GlossaryItemAdminForm(forms.ModelForm):
+    class Meta:
+        model = GlossaryItem
+        fields = "__all__"
+        widgets = {
+            "word": Textarea(attrs={"rows": 1, "cols": 30}),
+        }
+
+
+class LandingPageAdminForm(forms.ModelForm):
+    class Meta:
+        model = LandingPage
+        fields = "__all__"
+        widgets = {
+            "title": Textarea(attrs={"rows": 1, "cols": 30}),
+            "button_link": Textarea(attrs={"rows": 1, "cols": 30}),
+        }
+
+
+class StaticPageAdminForm(forms.ModelForm):
+    class Meta:
+        model = StaticPage
+        fields = "__all__"
+        widgets = {
+            "name": Textarea(attrs={"rows": 1, "cols": 30}),
+            "url": Textarea(attrs={"rows": 1, "cols": 30}),
+        }

territories_dashboard_lib/website_lib/migrations/0001_initial.py

@@ -0,0 +1,91 @@
+# Generated by Django 5.2.3 on 2025-06-18 13:09
+
+import martor.models
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='GlossaryItem',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('created_at', models.DateTimeField(auto_now_add=True)),
+                ('updated_at', models.DateTimeField(auto_now=True)),
+                ('word', models.TextField(verbose_name='Mot')),
+                ('definition', models.TextField(verbose_name='Définition')),
+            ],
+            options={
+                'verbose_name': 'Définition',
+                'verbose_name_plural': 'Page Lexique',
+                'ordering': ['word'],
+            },
+        ),
+        migrations.CreateModel(
+            name='LandingPage',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('created_at', models.DateTimeField(auto_now_add=True)),
+                ('updated_at', models.DateTimeField(auto_now=True)),
+                ('title', models.TextField(verbose_name='Titre')),
+                ('body', martor.models.MartorField(verbose_name='Contenu')),
+                ('button_link', models.TextField(help_text='Au format markdown, par exemple : <br/><br/>[découvrir les indicateurs](/indicateurs/)', verbose_name='Lien du bouton')),
+            ],
+            options={
+                'verbose_name': "Page d'accueil",
+                'verbose_name_plural': "Page d'accueil",
+            },
+        ),
+        migrations.CreateModel(
+            name='MainConf',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('created_at', models.DateTimeField(auto_now_add=True)),
+                ('updated_at', models.DateTimeField(auto_now=True)),
+                ('title', models.TextField(default='Tableau de bord', verbose_name='Titre principal du site')),
+                ('entity', models.TextField(default='', help_text="Renseigner le nom de l'entité au même format que le logo officiel en respectant les mises à la ligne.", verbose_name='Entité qui possède le site')),
+                ('header_navigation', models.TextField(default='', help_text='Navigation du header, mettre les liens au format markdown avec un slash à la fin du lien, mettre une ligne vide entre chaque rubrique. <br/><br/>\n        \n        Une rubrique peut contenir un seul lien, ou bien plusiers, dans ce cas la rubrique sera sous forme de dropdown et il faut mettre un titre en premier. <br/><br/>Par exemple : <br/>\n        <br/><br/>\n        [Accueil](/accueil/)\n        <br/><br/>\n        [Indicateurs territoriaux](/indicateurs/)\n        <br/><br/>\n        À propos\n        [Présentation](/presentation/)\n        [Journal des versions](/journal/)\n        ', verbose_name='Navigation')),
+                ('footer_navigation', models.TextField(default='', help_text='Navigation du footer, mettre les liens au format markdown, un par ligne. <br/><br/>\n    Si le lien est interne, commencer et terminer le lien par un slash comme "/accueil/"<br/><br/>\n    Par exemple : <br/><br/>\n    [Plan du site](/plan-site/)<br/>\n    [Accessibilité](/accessibilite/)<br/>\n    [Mentions légales](/mentions-legales/) <br/>\n    ', verbose_name='Navigation')),
+            ],
+            options={
+                'verbose_name': 'Configuration principale',
+                'verbose_name_plural': 'Configurations principales',
+            },
+        ),
+        migrations.CreateModel(
+            name='NoticeBanner',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('created_at', models.DateTimeField(auto_now_add=True)),
+                ('updated_at', models.DateTimeField(auto_now=True)),
+                ('title', models.CharField(max_length=64, verbose_name='Titre')),
+                ('description', models.CharField(max_length=255, verbose_name='Description')),
+                ('link_href', models.CharField(blank=True, help_text="Le lien doit être un lien interne et commencer et terminer par '/', par exemple '/journal/", max_length=255, null=True, verbose_name='Lien')),
+                ('link_text', models.CharField(blank=True, help_text='à remplir seulement si un lien est spécifié', max_length=64, null=True, verbose_name='Intitulé du lien')),
+            ],
+            options={
+                'ordering': ['-created_at'],
+            },
+        ),
+        migrations.CreateModel(
+            name='StaticPage',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('created_at', models.DateTimeField(auto_now_add=True)),
+                ('updated_at', models.DateTimeField(auto_now=True)),
+                ('name', models.TextField(verbose_name='Nom de la page')),
+                ('url', models.TextField(help_text="En minuscule avec des espaces remplacés par des traits '-'.<br/>Par exemple : <br/><br/> indicateurs <br/> mentions-legales", verbose_name='Url de la page')),
+                ('body', martor.models.MartorField(verbose_name='Contenu')),
+            ],
+            options={
+                'verbose_name': 'Page Statique',
+                'verbose_name_plural': 'Pages Statiques',
+            },
+        ),
+    ]