territories-dashboard-lib 0.1.0__tar.gz → 0.1.2__tar.gz

territories_dashboard_lib-0.1.2/MANIFEST.in

@@ -0,0 +1,5 @@
+recursive-include territories_dashboard_lib *.js *.mjs *.css *.html
+include README.md
+include licence.md
+
+prune territories_dashboard_lib/website_lib/react-components

{territories_dashboard_lib-0.1.0 → territories_dashboard_lib-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: territories-dashboard-lib
-Version: 0.1.0
+Version: 0.1.2
 Summary: Librairie pour la visualisation d'indicateurs territoriaux.
 Author-email: Bastien <bastien@prune.sh>
 License: LICENCE OUVERTE 2.0/OPEN LICENCE 2.0

{territories_dashboard_lib-0.1.0 → territories_dashboard_lib-0.1.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "territories-dashboard-lib"
-version = "0.1.0"
+version = "0.1.2"
 description = "Librairie pour la visualisation d'indicateurs territoriaux."
 authors = [
     { name = "Bastien", email = "bastien@prune.sh" }
@@ -19,7 +19,6 @@ classifiers = [
 ]
 
 [tool.setuptools]
-packages = ["territories_dashboard_lib"]
 include-package-data = true
 
 [build-system]

territories_dashboard_lib-0.1.2/territories_dashboard_lib/commons/decorators.py

@@ -0,0 +1,36 @@
+import functools
+from typing import get_origin
+
+from django.http import HttpResponse
+from pydantic import ValidationError
+
+
+def use_payload(payload_class):
+    def decorator(func):
+        @functools.wraps(func)
+        def wrapper(request, *args, **kwargs):
+            if request.method != "GET":
+                raise NotImplementedError
+            data = {}
+            for field_name, field in payload_class.model_fields.items():
+                url_name = field.alias if field.alias else field_name
+                is_list_field = get_origin(field.annotation) is list
+                url_value = (
+                    request.GET.getlist(url_name)
+                    if is_list_field
+                    else request.GET.get(url_name)
+                )
+                if url_value is not None:
+                    data[url_name] = url_value
+            try:
+                payload = payload_class.model_validate(data)
+            except ValidationError as e:
+                return HttpResponse(
+                    e.json(), headers={"content_type": "application/json"}, status=400
+                )
+
+            return func(request, *args, payload=payload, **kwargs)
+
+        return wrapper
+
+    return decorator

territories_dashboard_lib-0.1.2/territories_dashboard_lib/commons/models.py

@@ -0,0 +1,9 @@
+from django.db import models
+
+
+class CommonModel(models.Model):
+    created_at = models.DateTimeField(auto_now_add=True)
+    updated_at = models.DateTimeField(auto_now=True)
+
+    class Meta:
+        abstract = True

territories_dashboard_lib-0.1.2/territories_dashboard_lib/geo_lib/admin.py

@@ -0,0 +1,64 @@
+from django import forms
+from django.contrib import admin
+from django.db import models
+from django.utils.safestring import mark_safe
+
+from territories_dashboard_lib.geo_lib.models import GeoElement, GeoFeature
+
+
+class GeoColumnInLine(admin.TabularInline):
+    model = GeoElement
+    fields = ["name", "label", "filterable"]
+    extra = 0
+    formfield_overrides = {
+        models.TextField: {"widget": forms.TextInput()},
+    }
+
+
+class GeoFeatureForm(forms.ModelForm):
+    svg_file = forms.FileField(required=False, label="Charger un fichier SVG")
+
+    class Meta:
+        model = GeoFeature
+        fields = [
+            "indicator",
+            "name",
+            "title",
+            "unite",
+            "geo_type",
+            "color",
+            "show_on_fr_level",
+            "point_icon_svg",
+            "svg_file",
+        ]
+
+    def clean(self):
+        cleaned_data = super().clean()
+        svg_file = cleaned_data.get("svg_file")
+
+        if svg_file:
+            svg_content = svg_file.read().decode("utf-8")
+            cleaned_data["point_icon_svg"] = svg_content
+
+        return cleaned_data
+
+
+class GeoTableAdmin(admin.ModelAdmin):
+    form = GeoFeatureForm
+    inlines = [GeoColumnInLine]
+    formfield_overrides = {
+        models.TextField: {"widget": forms.TextInput()},
+    }
+    list_display = ["__str__", "indicator"]
+    list_filter = ["indicator"]
+    readonly_fields = ["svg_preview"]
+
+    def svg_preview(self, obj):
+        if obj.point_icon_svg:
+            return mark_safe(obj.point_icon_svg)
+        return "-"
+
+    svg_preview.short_description = "Prévisualisation du SVG"
+
+
+admin.site.register(GeoFeature, GeoTableAdmin)

territories_dashboard_lib-0.1.2/territories_dashboard_lib/geo_lib/enums.py

@@ -0,0 +1,7 @@
+from django.db import models
+
+
+class GeoFeatureType(models.TextChoices):
+    point = "point"
+    line = "line"
+    polygon = "polygon"

territories_dashboard_lib-0.1.2/territories_dashboard_lib/geo_lib/migrations/0001_initial.py

@@ -0,0 +1,51 @@
+# Generated by Django 5.2.3 on 2025-06-19 07:13
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('indicators_lib', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='GeoFeature',
+            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(help_text='attention le nom doit être exactement le même que celui en base.', verbose_name='Nom de la table en base')),
+                ('title', models.TextField(default='à compléter', verbose_name='Titre à afficher')),
+                ('unite', models.TextField(verbose_name='Unité au pluriel')),
+                ('geo_type', models.TextField(choices=[('point', 'Point'), ('line', 'Line'), ('polygon', 'Polygon')], default='point', verbose_name='Type de géométrie')),
+                ('point_icon_svg', models.TextField(blank=True, help_text="Icone SVG a utilisé pour les points.<br/>Laisser vide pour les autres types de géométrie.<br/>Veuillez charger un fichier provenant des <a href='/'>Material Icons</a> de Google.", null=True, verbose_name='Icone des points')),
+                ('color', models.TextField(default='#000000', help_text="Couleur des données sur la date, à renseigner au format hexadécimal, par exemple: '#05B2F9'", verbose_name='Couleur')),
+                ('show_on_fr_level', models.BooleanField(default=True, help_text='Décochez si la quantité de données est trop importante pour le niveau France entière.', verbose_name='Afficher au niveau France entière')),
+                ('indicator', models.ForeignKey(help_text="Cette donnée géographique sera ajoutée à la carte de l'indicateur.", on_delete=django.db.models.deletion.CASCADE, related_name='geo_features', to='indicators_lib.indicator')),
+            ],
+            options={
+                'verbose_name': 'Données de la carte',
+                'ordering': ('indicator', 'name'),
+            },
+        ),
+        migrations.CreateModel(
+            name='GeoElement',
+            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 colonne en DB')),
+                ('label', models.TextField()),
+                ('filterable', models.BooleanField(default=True, verbose_name='Filtrable')),
+                ('geo_feature', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='items', to='geo_lib.geofeature')),
+            ],
+            options={
+                'abstract': False,
+            },
+        ),
+    ]

territories_dashboard_lib-0.1.2/territories_dashboard_lib/geo_lib/models.py

@@ -0,0 +1,58 @@
+from django.db import models
+
+from territories_dashboard_lib.commons.models import CommonModel
+from territories_dashboard_lib.indicators_lib.models import Indicator
+
+from .enums import GeoFeatureType
+
+
+class GeoFeature(CommonModel):
+    name = models.TextField(
+        verbose_name="Nom de la table en base",
+        help_text="attention le nom doit être exactement le même que celui en base.",
+    )
+    title = models.TextField(verbose_name="Titre à afficher", default="à compléter")
+    unite = models.TextField(verbose_name="Unité au pluriel")
+    indicator = models.ForeignKey(
+        Indicator,
+        related_name="geo_features",
+        on_delete=models.CASCADE,
+        help_text="Cette donnée géographique sera ajoutée à la carte de l'indicateur.",
+    )
+    geo_type = models.TextField(
+        choices=GeoFeatureType.choices,
+        default=GeoFeatureType.point,
+        verbose_name="Type de géométrie",
+    )
+    point_icon_svg = models.TextField(
+        blank=True,
+        null=True,
+        verbose_name="Icone des points",
+        help_text="Icone SVG a utilisé pour les points.<br/>Laisser vide pour les autres types de géométrie.<br/>Veuillez charger un fichier provenant des <a href='/'>Material Icons</a> de Google.",
+    )
+    color = models.TextField(
+        default="#000000",
+        verbose_name="Couleur",
+        help_text="Couleur des données sur la date, à renseigner au format hexadécimal, par exemple: '#05B2F9'",
+    )
+    show_on_fr_level = models.BooleanField(
+        default=True,
+        verbose_name="Afficher au niveau France entière",
+        help_text="Décochez si la quantité de données est trop importante pour le niveau France entière.",
+    )
+
+    def __str__(self):
+        return self.name
+
+    class Meta:
+        ordering = ("indicator", "name")
+        verbose_name = "Données de la carte"
+
+
+class GeoElement(CommonModel):
+    geo_feature = models.ForeignKey(
+        GeoFeature, related_name="items", on_delete=models.CASCADE
+    )
+    name = models.TextField(verbose_name="Nom de la colonne en DB")
+    label = models.TextField()
+    filterable = models.BooleanField(default=True, verbose_name="Filtrable")

territories_dashboard_lib-0.1.2/territories_dashboard_lib/geo_lib/urls.py

@@ -0,0 +1,27 @@
+from django.urls import path
+
+from .views import (
+    geo_features_view,
+    main_territory_view,
+    precise_view,
+    search_territories_view,
+    territories_view,
+)
+
+app_name = "geo-api"
+
+urlpatterns = [
+    path(
+        "geo-features/",
+        geo_features_view,
+        name="geo-features",
+    ),
+    path(
+        "main-territory/",
+        main_territory_view,
+        name="main-territory",
+    ),
+    path("precise/", precise_view, name="precise"),
+    path("territories/", territories_view, name="territories"),
+    path("search-territories/", search_territories_view, name="search"),
+]

territories_dashboard_lib-0.1.2/territories_dashboard_lib/geo_lib/views.py

@@ -0,0 +1,239 @@
+import base64
+import gzip
+import json
+from typing import Optional
+
+from django.http import HttpResponse, JsonResponse
+from django.shortcuts import get_object_or_404
+from django.views.decorators.cache import cache_control
+from django.views.decorators.http import require_GET
+from psycopg2.sql import SQL, Identifier, Literal
+from pydantic import BaseModel
+
+from territories_dashboard_lib.indicators_lib.enums import (
+    FRANCE_GEOLEVEL_TITLES,
+    MESH_DB,
+    GeoLevel,
+    MeshLevel,
+)
+from territories_dashboard_lib.indicators_lib.query.commons import get_territories_ids
+from territories_dashboard_lib.indicators_lib.query.utils import run_custom_query
+
+from .enums import GeoFeatureType
+from .models import GeoFeature
+
+
+class GeoFeaturesParams(BaseModel):
+    mesh: MeshLevel
+    geo_level: GeoLevel
+    main_territories: str
+    last: Optional[str] = None
+    limit: Optional[str] = "1000"
+    feature: str
+
+
+@require_GET
+@cache_control(max_age=3600)
+def geo_features_view(request):
+    params = GeoFeaturesParams(**request.GET.dict())
+
+    geo_feature = get_object_or_404(GeoFeature, id=params.feature)
+    geo_level = params.geo_level
+    mesh = params.mesh
+    main_territory_codes = params.main_territories.split(",")
+    last = params.last
+    limit = params.limit
+
+    last_year_query = (
+        f"SELECT DISTINCT annee FROM {geo_feature.name} ORDER BY annee DESC"
+    )
+    years = run_custom_query(last_year_query)
+    last_year = years[0].get("annee")
+
+    territories_ids = get_territories_ids(main_territory_codes, geo_level, mesh)
+
+    col_id_name = f"code_{mesh}"
+    columns = [el.name for el in geo_feature.items.all()]
+
+    coma = ", " if columns else ""
+    select_geo_code = (
+        f", geo.{col_id_name} AS geo_code"
+        if geo_feature.geo_type == GeoFeatureType.point
+        else ""
+    )
+
+    if geo_feature.geo_type == GeoFeatureType.point:
+        where_clause = f"WHERE geo.{col_id_name} IN ('{"', '".join(territories_ids)}')"
+    else:
+        where_clause = (
+            f"JOIN contours_simplified_{geo_level} contours ON ST_intersects(geo.geometry, contours.geometry)\n"
+            f"WHERE contours.code IN ('{"', '".join(main_territory_codes)}')"
+        )
+    where_clause += f" AND annee = {last_year}"
+
+    pagination = f"AND order_id > {last or 0} ORDER BY order_id ASC LIMIT {limit}"
+
+    query = (
+        f"SELECT ST_asgeojson(geo.geometry) AS geojson, order_id{coma + ', '.join(columns)}\n"
+        f"{select_geo_code}\n"
+        f"FROM {geo_feature.name} AS geo\n"
+        f"{where_clause} {pagination}"
+    )
+
+    # Execute the query
+    results = run_custom_query(query)
+    items = geo_feature.items.all()
+    # Transform results
+    data = [
+        {
+            "type": "Feature",
+            "id": r.get("geo_code"),
+            "properties": {el.label: r.get(el.name) for el in items},
+            "geometry": json.loads(r.get("geojson")),
+        }
+        for r in results
+    ]
+
+    last_queried_order_id = results[-1]["order_id"] if results else None
+
+    compressed_data = gzip.compress(json.dumps(data).encode())
+    compressed_base64 = base64.b64encode(compressed_data).decode()
+
+    return JsonResponse({"data": compressed_base64, "last": last_queried_order_id})
+
+
+class MainTerritoryParams(BaseModel):
+    geo_level: GeoLevel
+    geo_id: str
+
+
+@require_GET
+@cache_control(max_age=3600)
+def main_territory_view(request):
+    params = MainTerritoryParams(**request.GET.dict())
+
+    codes = ", ".join(f"'{code.strip()}'" for code in params.geo_id.split(","))
+
+    query = f"""
+        SELECT code as id, ST_asgeojson(ST_simplify(geometry, 0.01)) AS polygon
+        FROM contours_simplified_{params.geo_level}
+        WHERE code IN ({codes})
+        """
+
+    results = run_custom_query(query)
+
+    data = [
+        {
+            "id": r.get("id"),
+            "polygon": json.loads(r.get("polygon")),
+        }
+        for r in results
+    ]
+
+    return JsonResponse(data, safe=False)
+
+
+@require_GET
+@cache_control(max_age=3600)
+def precise_view(request):
+    territories_ids = request.GET.get("territories", "").split(",")
+    mesh_level = request.GET.get("mesh")
+
+    if not mesh_level:
+        return JsonResponse({"error": "Missing 'mesh' parameter"}, status=400)
+
+    mapped_mesh_level = "DEPCOM" if mesh_level == "com" else mesh_level.upper()
+
+    query = f"""
+        SELECT "{mapped_mesh_level}" AS id, ST_asgeojson(geometry) AS polygon
+        FROM contours_geo_ign_{mesh_level}
+        WHERE "{mapped_mesh_level}" IN ('{"', '".join(territories_ids)}')
+        """
+
+    results = run_custom_query(query)
+
+    territories = {r.get("id"): json.loads(r.get("polygon")) for r in results}
+
+    return JsonResponse(territories)
+
+
+class TerritoryFeatureParams(BaseModel):
+    mesh: MeshLevel
+    geo_level: GeoLevel | None = None
+    main_territories: str | None = None
+    codes: str | None = None
+
+
+@require_GET
+@cache_control(max_age=3600)
+def territories_view(request):
+    params = TerritoryFeatureParams(**request.GET.dict())
+    geo_level = params.geo_level
+    mesh = params.mesh
+
+    if params.codes:
+        territories_ids = params.codes.split(",")
+    else:
+        main_territory_codes = params.main_territories.split(",")
+        territories_ids = get_territories_ids(main_territory_codes, geo_level, mesh)
+
+    query = f"""
+        SELECT code AS id, ST_asgeojson(geometry) AS polygon
+        FROM contours_simplified_{params.mesh}
+        WHERE code IN ('{"', '".join(territories_ids)}')
+        """
+
+    results = run_custom_query(query)
+
+    data = [
+        {"type": "Feature", "id": r.get("id"), "geometry": json.loads(r.get("polygon"))}
+        for r in results
+    ]
+    return JsonResponse(data, safe=False)
+
+
+def _fill_territory_li(code, name, mesh):
+    label = name if mesh == MeshLevel.National else f"{name} - {code}"
+    return f"""<li data-code="{code}" data-name="{name}" onclick="chooseTerritory(this)"><button aria-label="Choisir {label}">{label}</button></li>"""
+
+
+@require_GET
+@cache_control(max_age=3600)
+def search_territories_view(request):
+    request_mesh = request.GET.get("mesh")
+    if request_mesh in MeshLevel:
+        mesh = request_mesh
+    else:
+        raise ValueError("mesh")
+    if mesh == MeshLevel.National:
+        lis = []
+        for code, name in FRANCE_GEOLEVEL_TITLES.items():
+            li = _fill_territory_li(code, name, mesh)
+            lis.append(li)
+        return HttpResponse("\n".join(lis))
+    mesh_db = MESH_DB[mesh]
+    pagination = 20
+    search = request.GET.get("search", "")
+    offset = int(request.GET.get("offset", 0))
+    query = SQL("""
+    SELECT DISTINCT {code} as code, {name} as name FROM arborescence_geo
+    WHERE unaccent({name}) || {code} ILIKE unaccent(%s)
+    AND "FR" <> 'ETR'
+    ORDER BY {name}, {code}
+    LIMIT {limit} OFFSET {offset};
+    ;
+    """).format(
+        code=Identifier(mesh_db),
+        name=Identifier(f"NOM_{mesh_db}"),
+        offset=Literal(offset * pagination),
+        limit=Literal(pagination),
+    )
+    territories = run_custom_query(query, [f"%{search}%"])
+    lis = []
+    for territory in territories:
+        li = _fill_territory_li(territory["code"], territory["name"], mesh)
+        lis.append(li)
+    if len(territories) == pagination:
+        li = f"""<li data-type="load"><button onclick="loadMoreTerritories(this)" data-mesh="{mesh}" data-offset="{offset + 1}" class="fr-btn fr-btn--secondary fr-btn--sm">Charger plus de résultats</button></li>"""
+        lis.append(li)
+    return HttpResponse("\n".join(lis))

territories_dashboard_lib-0.1.2/territories_dashboard_lib/indicators_lib/admin.py

@@ -0,0 +1,140 @@
+import nested_admin
+from django.contrib import admin
+from django.db.models import TextField
+from django.forms import TextInput
+from django.shortcuts import redirect
+from django.urls import path, reverse
+from django.utils.html import format_html
+
+from territories_dashboard_lib.indicators_lib.methodo_pdf import reset_methodo_file
+from territories_dashboard_lib.indicators_lib.models import (
+    Dimension,
+    Filter,
+    Indicator,
+    SubTheme,
+    Theme,
+)
+from territories_dashboard_lib.indicators_lib.refresh_filters import refresh_filters
+
+
+class FilterInline(nested_admin.NestedTabularInline):  # type: ignore
+    model = Filter
+    extra = 0
+    formfield_overrides = {TextField: {"widget": TextInput(attrs={"size": "32"})}}
+
+
+class DimensionInline(nested_admin.NestedTabularInline):  # type: ignore
+    model = Dimension
+    extra = 0
+    inlines = [FilterInline]
+    formfield_overrides = {TextField: {"widget": TextInput(attrs={"size": "32"})}}
+
+
+class IndicatorAdmin(nested_admin.NestedModelAdmin):
+    model = Indicator
+    inlines = [DimensionInline]
+    list_display = [
+        "name",
+        "title",
+        "sub_theme",
+        "index_in_theme",
+        "is_active",
+    ]
+
+    def save_model(self, request, indicator, form, change):
+        super().save_model(request, indicator, form, change)
+        if "methodo" in form.changed_data:
+            reset_methodo_file(indicator)
+
+    def change_view(self, request, object_id, form_url="", extra_context=None):
+        extra_context = extra_context or {}
+        extra_context["refresh_url"] = f"../../{object_id}/refresh_filters/"
+        return super().change_view(request, object_id, form_url, extra_context)
+
+    def get_urls(self):
+        urls = super().get_urls()
+        custom_urls = [
+            path(
+                "<path:object_id>/refresh_filters/",
+                self.admin_site.admin_view(self.refresh_filters_view),
+                name="refresh_filters",
+            ),
+        ]
+        return custom_urls + urls
+
+    def refresh_filters_view(self, request, object_id):
+        indicator = Indicator.objects.get(pk=object_id)
+        try:
+            for dimension in indicator.dimensions.all():
+                refresh_filters(dimension)
+            self.message_user(request, "Les filtres ont été actualisés.")
+        except Exception as e:
+            print(e)
+            self.message_user(
+                request,
+                f"Erreur lors de l'actualisation des filtres: {str(e)}",
+                level="error",
+            )
+
+        return redirect("../")
+
+
+class IndicatorInline(admin.TabularInline):
+    model = Indicator
+    extra = 0
+    fields = ["name", "index_in_theme", "link"]
+    readonly_fields = ["link"]
+    ordering = ["index_in_theme"]
+
+    def link(self, obj):
+        url = reverse("admin:indicators_lib_indicator_change", args=[obj.id])
+        return format_html(f'<a href="{url}">Edit</a>')
+
+
+class SubThemesInline(admin.TabularInline):
+    model = SubTheme
+    extra = 0
+    fields = [
+        "name",
+        "index_in_theme",
+        "indicators_count",
+        "is_displayed_on_app",
+        "link",
+    ]
+    ordering = ["index_in_theme"]
+    readonly_fields = ["indicators_count", "is_displayed_on_app", "link"]
+
+    def link(self, obj):
+        url = reverse("admin:indicators_lib_subtheme_change", args=[obj.id])
+        return format_html(f'<a href="{url}">Edit</a>')
+
+    link.short_description = "Link"
+
+
+class ThemeAdmin(admin.ModelAdmin):
+    model = Theme
+    inlines = [SubThemesInline]
+    list_display = [
+        "title",
+        "ordering",
+        "subthemes_count",
+        "indicators_count",
+        "is_displayed_on_app",
+    ]
+
+
+class SubThemeAdmin(admin.ModelAdmin):
+    model = SubTheme
+    inlines = [IndicatorInline]
+    list_display = [
+        "title",
+        "theme",
+        "index_in_theme",
+        "indicators_count",
+        "is_displayed_on_app",
+    ]
+
+
+admin.site.register(Theme, ThemeAdmin)
+admin.site.register(SubTheme, SubThemeAdmin)
+admin.site.register(Indicator, IndicatorAdmin)