data-inclusion-schema 0.20.0__py3-none-any.whl

data_inclusion/schema/__init__.py

@@ -0,0 +1,47 @@
+from data_inclusion.schema.common import (
+    CodeCommune,
+    CodeDepartement,
+    CodeEPCI,
+    CodePostal,
+    CodeRegion,
+    CodeRna,
+    CodeSiren,
+    CodeSiret,
+)
+from data_inclusion.schema.frais import Frais
+from data_inclusion.schema.labels_nationaux import LabelNational
+from data_inclusion.schema.modes_accueil import ModeAccueil
+from data_inclusion.schema.modes_orientation import (
+    ModeOrientationAccompagnateur,
+    ModeOrientationBeneficiaire,
+)
+from data_inclusion.schema.profils import Profil
+from data_inclusion.schema.services import Service
+from data_inclusion.schema.structures import Structure
+from data_inclusion.schema.thematiques import Thematique
+from data_inclusion.schema.typologies_de_services import TypologieService
+from data_inclusion.schema.typologies_de_structures import Typologie
+from data_inclusion.schema.zones_de_diffusion import ZoneDiffusionType
+
+__all__ = [
+    "CodeCommune",
+    "CodeDepartement",
+    "CodeEPCI",
+    "CodePostal",
+    "CodeRegion",
+    "CodeRna",
+    "CodeSiren",
+    "CodeSiret",
+    "Frais",
+    "LabelNational",
+    "ModeAccueil",
+    "ModeOrientationAccompagnateur",
+    "ModeOrientationBeneficiaire",
+    "Profil",
+    "Service",
+    "Structure",
+    "Thematique",
+    "TypologieService",
+    "Typologie",
+    "ZoneDiffusionType",
+]

data_inclusion/schema/__main__.py

@@ -0,0 +1,71 @@
+import json
+import pathlib
+
+from data_inclusion.schema import (
+    Frais,
+    LabelNational,
+    ModeAccueil,
+    ModeOrientationAccompagnateur,
+    ModeOrientationBeneficiaire,
+    Profil,
+    Service,
+    Structure,
+    Thematique,
+    Typologie,
+    TypologieService,
+    ZoneDiffusionType,
+)
+
+
+def json_dump(obj, file):
+    json.dump(
+        obj,
+        file,
+        indent=2,
+        ensure_ascii=False,
+        sort_keys=True,
+    )
+
+
+def main():
+    output_dir = pathlib.Path() / "schemas"
+    output_dir.mkdir(exist_ok=True)
+
+    for model in [Structure, Service]:
+        with (output_dir / f"{model.__name__.lower()}.json").open("w") as file:
+            json.dump(
+                model.model_json_schema(),
+                file,
+                indent=2,
+                ensure_ascii=False,
+                sort_keys=True,
+            )
+
+    # fichiers supplémentaires documentant les énumérations
+
+    (output_dir / "extra").mkdir(exist_ok=True)
+
+    enum_x_file_tuples_list = [
+        ("frais.json", Frais),
+        ("labels-nationaux.json", LabelNational),
+        ("modes-accueil.json", ModeAccueil),
+        ("modes-orientation-accompagnateur.json", ModeOrientationAccompagnateur),
+        ("modes-orientation-beneficiaire.json", ModeOrientationBeneficiaire),
+        ("profils.json", Profil),
+        ("thematiques.json", Thematique),
+        ("typologies-de-services.json", TypologieService),
+        ("typologies-de-structures.json", Typologie),
+        ("zones-de-diffusion-types.json", ZoneDiffusionType),
+    ]
+
+    for filename, enum in enum_x_file_tuples_list:
+        with (output_dir / "extra" / filename).open("w") as file:
+            json_dump(enum.as_dict_list(), file)
+
+
+if __name__ == "__main__":
+    """
+    Usage:
+        $ python -m data_inclusion.schema
+    """
+    main()

data_inclusion/schema/base.py

@@ -0,0 +1,77 @@
+import enum
+import textwrap
+
+import pydantic
+
+
+def Field(*args, **kwargs):
+    if "description" in kwargs:
+        kwargs["description"] = (
+            textwrap.dedent(kwargs["description"].strip("\n"))
+            .replace("\n", " ")
+            .strip()
+        )
+    return pydantic.Field(*args, **kwargs)
+
+
+class BaseModel(pydantic.BaseModel):
+    @classmethod
+    def model_list_json_schema(
+        cls,
+        title: str,
+        id: str,
+        description: str,
+    ) -> dict:
+        adapter = pydantic.TypeAdapter(list[cls])
+        schema = adapter.json_schema()
+
+        return {
+            "title": title,
+            "$schema": "http://json-schema.org/draft-07/schema",
+            "$id": id,
+            "description": description,
+            **schema,
+        }
+
+
+class EnhancedEnum(str, enum.Enum):
+    def __new__(cls, value, label, description):
+        obj = str.__new__(cls, value)
+        obj._value_ = value
+        obj._label = label
+        obj._description = (
+            textwrap.dedent(description).strip("\n").replace("\n", " ")
+            if description
+            else None
+        )
+
+        try:
+            if obj._description is not None:
+                if not obj._description[0].isupper():
+                    raise ValueError("description must start with uppercase letter")
+        except ValueError as err:
+            raise ValueError(f"{cls.__name__}({value})'s {err}")
+
+        return obj
+
+    @classmethod
+    def as_dict_list(cls) -> list[dict]:
+        return sorted(
+            [
+                {
+                    "value": instance.value,
+                    "label": instance.label,
+                    "description": instance.description,
+                }
+                for instance in cls
+            ],
+            key=lambda d: d["value"],
+        )
+
+    @property
+    def label(self) -> str:
+        return self._label
+
+    @property
+    def description(self) -> str:
+        return self._description

data_inclusion/schema/common.py

@@ -0,0 +1,41 @@
+from typing import TypeAlias
+
+from pydantic import StringConstraints
+from typing_extensions import Annotated
+
+CodePostal: TypeAlias = Annotated[
+    str,
+    StringConstraints(min_length=5, max_length=5, pattern=r"^\d{5}$"),
+]
+
+CodeRna: TypeAlias = Annotated[
+    str,
+    StringConstraints(min_length=10, max_length=10, pattern=r"^W\d{9}$"),
+]
+
+CodeSiren: TypeAlias = Annotated[
+    str,
+    StringConstraints(min_length=9, max_length=9, pattern=r"^\d{9}$"),
+]
+
+CodeSiret: TypeAlias = Annotated[
+    str,
+    StringConstraints(min_length=14, max_length=14, pattern=r"^\d{14}$"),
+]
+
+CodeCommune: TypeAlias = Annotated[
+    str,
+    StringConstraints(min_length=5, max_length=5, pattern=r"^\w{5}$"),
+]
+
+CodeEPCI: TypeAlias = CodeSiren
+
+CodeDepartement: TypeAlias = Annotated[
+    str,
+    StringConstraints(min_length=2, max_length=3, pattern=r"^\w{2,3}$"),
+]
+
+CodeRegion: TypeAlias = Annotated[
+    str,
+    StringConstraints(min_length=2, max_length=2, pattern=r"^\d{2}$"),
+]

data_inclusion/schema/frais.py

@@ -0,0 +1,32 @@
+from data_inclusion.schema.base import EnhancedEnum
+
+
+class Frais(EnhancedEnum):
+    GRATUIT = (
+        "gratuit",
+        "Gratuit",
+        "Je peux accéder gratuitement au lieu et à ses services",
+    )
+    GRATUIT_SOUS_CONDITIONS = (
+        "gratuit-sous-conditions",
+        "Gratuit sous conditions",
+        """
+            La gratuité est conditionnée à des critères (situation familiale,
+            convention avec un organisme social…)
+        """,
+    )
+    PAYANT = (
+        "payant",
+        "Payant",
+        "L’accès au lieu et/ou à ses services est payant",
+    )
+    ADHESION = (
+        "adhesion",
+        "Adhésion",
+        "L’accès au lieu et/ou à ses services nécessite d’y adhérer",
+    )
+    PASS_NUMERIQUE = (
+        "pass-numerique",
+        "Accepte le pass numérique",
+        "Il est possible d’utiliser un Pass numérique pour accéder au lieu",
+    )

data_inclusion/schema/labels_nationaux.py

@@ -0,0 +1,429 @@
+from data_inclusion.schema.base import EnhancedEnum
+
+
+class LabelNational(EnhancedEnum):
+    SOIXANTE_MILLE_REBONDS = (
+        "60000-rebonds",
+        "60 000 rebonds",
+        None,
+    )
+    ACTION_LOGEMENT = (
+        "action-logement",
+        "Action logement",
+        None,
+    )
+    ADIE = (
+        "adie",
+        "Adie",
+        None,
+    )
+    AFPA = (
+        "afpa",
+        "AFPA",
+        None,
+    )
+    AGEFIPH = (
+        "agefiph",
+        "AGEFIPH",
+        None,
+    )
+    AIDANTS_CONNECT = (
+        "aidants-connect",
+        "Aidants Connect",
+        None,
+    )
+    ALLIANCE_VILLES_EMPLOI = (
+        "alliance-villes-emploi",
+        "Alliance villes emploi",
+        None,
+    )
+    ANLCI = (
+        "anlci",
+        "ANLCI",
+        None,
+    )
+    APEC = (
+        "apec",
+        "APEC",
+        None,
+    )
+    APELS = (
+        "apels",
+        "APELS Agence Pour l’Education par Le Sport",
+        None,
+    )
+    APPRENTIS_DAUTEUIL = (
+        "apprentis-dauteuil",
+        "Apprentis d’Auteuil",
+        None,
+    )
+    APTIC = (
+        "aptic",
+        "APTIC",
+        None,
+    )
+    BANQUES_ALIMENTAIRES = (
+        "banques-alimentaires",
+        "Banques alimentaires",
+        None,
+    )
+    BGE = (
+        "bge",
+        "BGE",
+        None,
+    )
+    CAF = (
+        "caf",
+        "CAF",
+        None,
+    )
+    CAMPUS_CONNECTE = (
+        "campus-connecte",
+        "Campus connecté",
+        None,
+    )
+    CCI = (
+        "cci",
+        "CCI",
+        None,
+    )
+    CHANTIER_ECOLE = (
+        "chantier-ecole",
+        "Chantier école",
+        None,
+    )
+    CAP_EMPLOI_RESEAU_CHEOPS = (
+        "cap-emploi-reseau-cheops",
+        "CAP Emploi - Réseau CHEOPS",
+        None,
+    )
+    CIDFF = (
+        "cidff",
+        "CIDFF",
+        None,
+    )
+    CNAM = (
+        "cnam",
+        "CNAM",
+        None,
+    )
+    COLLECTIF_EMPLOI = (
+        "collectif-emploi",
+        "Collectif emploi",
+        None,
+    )
+    CONSEILLER_NUMERIQUE = (
+        "conseiller-numerique",
+        "Conseiller numérique",
+        None,
+    )
+    COORACE = (
+        "coorace",
+        "Coorace",
+        None,
+    )
+    CREPI = (
+        "crepi",
+        "CREPI",
+        None,
+    )
+    CRESUS = (
+        "cresus",
+        "Crésus",
+        None,
+    )
+    CROIX_ROUGE = (
+        "croix-rouge",
+        "Croix rouge",
+        None,
+    )
+    DIHAL = (
+        "dihal",
+        "DIHAL",
+        None,
+    )
+    DUO_FOR_A_JOB = (
+        "duo-for-a-job",
+        "Duo for a job",
+        None,
+    )
+    ECOLES_DE_LA_DEUXIEME_CHANCE = (
+        "ecoles-de-la-deuxieme-chance",
+        "E2C - École de la 2e chance",
+        None,
+    )
+    EGEE = (
+        "egee",
+        "EGEE",
+        None,
+    )
+    EMMAUS = (
+        "emmaus",
+        "Emmaus",
+        None,
+    )
+    ENVIE = (
+        "envie",
+        "Envie",
+        None,
+    )
+    EPIDE = (
+        "epide",
+        "EPIDE",
+        None,
+    )
+    ESPACE_EMPLOI_AGRIC_ARRCO = (
+        "espace-emploi-agric-arrco",
+        "Espace Emploi Agirc Arrco",
+        None,
+    )
+    ETCLD = (
+        "etcld",
+        "Expérimentation territoriale contre le chômage de longue durée",
+        None,
+    )
+    FABRIQUE_DE_TERRITOIRE = (
+        "fabrique-de-territoire",
+        "Fabrique de Territoire",
+        None,
+    )
+    FACE = (
+        "face",
+        "Fondation FACE",
+        None,
+    )
+    FEDE_PRO_FEM = (
+        "fede-pro-fem",
+        "Federation Professionnelle Pour les Femmes",
+        None,
+    )
+    FEDERATION_DES_ACTEURS_DE_LA_SOLIDARITE = (
+        "federation-des-acteurs-de-la-solidarite",
+        "Fédération des acteurs de la solidarité",
+        None,
+    )
+    FEDERATION_DES_ENTREPRISES_DINSERTION = (
+        "federation-des-entreprises-dinsertion",
+        "Fédération des entreprises d’insertion",
+        None,
+    )
+    FORCE_FEMMES = (
+        "force-femmes",
+        "Force Femmes",
+        None,
+    )
+    FRANCE_ACTIVE = (
+        "france-active",
+        "France Active",
+        None,
+    )
+    FRANCE_SERVICE = (
+        "france-service",
+        "France service",
+        None,
+    )
+    FRANCE_TRAVAIL = (
+        "france-travail",
+        "France Travail",
+        None,
+    )
+    FRENCH_TECH = (
+        "french-tech",
+        "French Tech",
+        None,
+    )
+    GEIQ = (
+        "geiq",
+        "GEIQ",
+        None,
+    )
+    GRANDES_ECOLES_DU_NUMERIQUE = (
+        "grandes-ecoles-du-numerique",
+        "Grand Test Couveuse d’entreprise",
+        None,
+    )
+    GRAND_TEST_COUVEUSE_DENTREPRISE = (
+        "grand-test-couveuse-dentreprise",
+        "Grandes écoles du numérique",
+        None,
+    )
+    HUP = (
+        "hup",
+        "H’UP",
+        None,
+    )
+    INAE = (
+        "inae",
+        "INAE",
+        None,
+    )
+    INITIATIVE_FRANCE = (
+        "initiative-france",
+        "Initiative France",
+        None,
+    )
+    KONEXIO = (
+        "konexio",
+        "Konexio",
+        None,
+    )
+    LA_CRAVATE_SOLIDAIRE = (
+        "la-cravate-solidaire",
+        "La Cravate Solidaire",
+        None,
+    )
+    LA_RESSOURCERIE = (
+        "la-ressourcerie",
+        "La ressourcerie",
+        None,
+    )
+    LES_PREMIERES = (
+        "les-premieres",
+        "Les Premières",
+        None,
+    )
+    LINKLUSION = (
+        "linklusion",
+        "Linklusion",
+        None,
+    )
+    MAISONS_DE_LEMPLOI = (
+        "maisons-de-lemploi",
+        "Maisons de l’Emploi",
+        None,
+    )
+    MDPH = (
+        "mdph",
+        "MDPH",
+        None,
+    )
+    MISSION_LOCALE = (
+        "mission-locale",
+        "Mission Locale",
+        None,
+    )
+    MOBIN = (
+        "mobin",
+        "Adhérent au Réseau Mob’In",
+        None,
+    )
+    NQT = (
+        "nqt",
+        "NQT",
+        None,
+    )
+    POINT_CONSEIL_BUDGET = (
+        "point-conseil-budget",
+        "Point conseil budget",
+        None,
+    )
+    POINT_JUSTICE = (
+        "point-justice",
+        "Points Justice",
+        None,
+    )
+    POSITIVE_PLANET = (
+        "positive-planet",
+        "Positive Planet",
+        None,
+    )
+    PROXITE = (
+        "proxite",
+        "Proxité",
+        None,
+    )
+    RESEAU_APP = (
+        "reseau-app",
+        "Réseau APP",
+        None,
+    )
+    RESEAU_ENTREPRENDRE = (
+        "reseau-entreprendre",
+        "Réseau Entreprendre",
+        None,
+    )
+    RESSOURCERIES = (
+        "ressourceries",
+        "Ressourceries",
+        None,
+    )
+    RESTOS_DU_COEUR = (
+        "restos-du-coeur",
+        "Restos du coeur",
+        None,
+    )
+    SCCONSEIL = (
+        "scconseil",
+        "SC Conseil",
+        None,
+    )
+    SECOURS_POPULAIRE = (
+        "secours-populaire",
+        "Secours populaire",
+        None,
+    )
+    SIAO = (
+        "siao",
+        "SIAO",
+        None,
+    )
+    SIMPLON = (
+        "simplon",
+        "Simplon",
+        None,
+    )
+    SINCA = (
+        "sinca",
+        "SINGA",
+        None,
+    )
+    SNC = (
+        "snc",
+        "SNC - Solidarité Nouvelle Face au Chômage",
+        None,
+    )
+    SPORT_DANS_LA_VILLE = (
+        "sport-dans-la-ville",
+        "Sport Dans La Ville",
+        None,
+    )
+    TOUS_TES_POSSIBLE = (
+        "tous-tes-possible",
+        "Tous Tes Possibles",
+        None,
+    )
+    TZCLD = (
+        "tzcld",
+        "TZCLD - Territoire Zero Chomeur Longue Durée",
+        None,
+    )
+    UNAF = (
+        "unaf",
+        "Union nationale de l’aide aux familles",
+        None,
+    )
+    UNAI = (
+        "unai",
+        "UNAI",
+        None,
+    )
+    UNCCAS = (
+        "unccas",
+        "Union nationale des centres communaux d’action sociale",
+        None,
+    )
+    UNEA = (
+        "unea",
+        "UNEA",
+        None,
+    )
+    UNIS_CITE = (
+        "unis-cite",
+        "Unis-Cité",
+        None,
+    )
+    WIMOOV = (
+        "wimoov",
+        "Wimoov",
+        None,
+    )

data_inclusion/schema/modes_accueil.py

@@ -0,0 +1,14 @@
+from data_inclusion.schema.base import EnhancedEnum
+
+
+class ModeAccueil(EnhancedEnum):
+    A_DISTANCE = (
+        "a-distance",
+        "À distance",
+        "Le service est proposé à distance, par téléphone ou internet.",
+    )
+    EN_PRESENTIEL = (
+        "en-presentiel",
+        "En présentiel",
+        "Le service est proposé en présentiel, à l'adresse associée à ce service.",
+    )