sinamet 0.0.1__tar.gz

sinamet-0.0.1/.gitignore

@@ -0,0 +1,15 @@
+dist/*
+site/*
+__pycache__
+
+# Data files
+*.xls
+*.xlsx
+*.csv
+
+# Shapefiles
+*.shp
+*.dbf
+*.shx
+*.cpg
+*.prj

sinamet-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Benoit Ribon, Dynartio
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

sinamet-0.0.1/PKG-INFO

@@ -0,0 +1,138 @@
+Metadata-Version: 2.4
+Name: sinamet
+Version: 0.0.1
+Summary: Structuring data to analyze territorial flows.
+Project-URL: Documentation, https://docs.sinamet.tech
+Project-URL: Source Code, https://github.com/dynartIO/sinamet
+Author-email: Benoit Ribon <b.ribon@dynartio.com>, libadmin@sinamet.tech
+License: MIT License
+        
+        Copyright (c) 2025 Benoit Ribon, Dynartio
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.11
+Requires-Dist: anytree>=2.12.1
+Requires-Dist: geoalchemy2>=0.16.0
+Requires-Dist: numpy>=2.2.1
+Requires-Dist: pandas>=2.2.3
+Requires-Dist: psycopg2-binary>=2.9.10
+Requires-Dist: shapely>=2.0.6
+Requires-Dist: sqlalchemy>=2.0.36
+Requires-Dist: unidecode>=1.3.8
+Provides-Extra: demo
+Requires-Dist: geopandas>=1.0.1; extra == 'demo'
+Requires-Dist: openpyxl>=3.1.5; extra == 'demo'
+Requires-Dist: xlrd>=2.0.1; extra == 'demo'
+Provides-Extra: mkdocs
+Requires-Dist: black; extra == 'mkdocs'
+Requires-Dist: mkdocs; extra == 'mkdocs'
+Requires-Dist: mkdocs-material; extra == 'mkdocs'
+Requires-Dist: mkdocstrings[python]; extra == 'mkdocs'
+Description-Content-Type: text/markdown
+
+# 🇫🇷 Français
+
+## À propos de Sinamet
+
+Sinamet est une bibliothèque Python spécialisée pour l'analyse des flux et stocks
+territorialisés\*. Sinamet prend en charge la gestion d'une
+base de données à travers un modèle de données spécifique. À travers ce modèle,
+il est possible de structurer des données sur différentes thématiques,
+tant qu'elles décrivent des flux territorialisés, par exemple :
+
+ * Des statistiques sur le transport de marchandises,
+ * Des déplacements domicile-travail,
+ * Des factures d’énergie et d'eau d'un patrimoine bâti,
+ * Des commandes d'un établissement de restauration collective,
+ * Des données sur la collecte de déchets,
+ * Et plein d'autres !
+
+Sinamet embarque les fonctionnalités pour faciliter la navigation dans ces données :
+organiser des hiérarchies d'objets, récupérer des flux ou des stocks associés
+à un territoire ou un acteur, convertir des unités ou des nomenclatures,
+suivre la temporalité et la source des données, ...
+
+\*On parle également d'étudier le "métabolisme territorial".
+Sinamet est d'ailleurs l'acronyme de "Système d'Information pour l'ANalyse du
+MÉtabolisme des Territoires"
+
+## Documentation
+
+Consultez la documentation en ligne: [https://docs.sinamet.tech](https://docs.sinamet.tech)
+
+## Contact
+
+Des questions à propos de la bibliothèque ? Vous souhaitez être formé à
+l'utilisation de l'outil ou vous souhaitez mettre un observatoire des flux sur
+votre territoire ? Contactez l'équipe de développement : libadmin@sinamet.tech
+
+## Credit
+
+Sinamet est une bibliothèque développée par [Dynartio](https://dynartio.com),
+initiée grâce au financement de l'[ADEME](https://ademe.fr) et le soutien du
+[Laboratoire LIVE (University or Strasbourg/CNRS)](https://live.unistra.fr)
+et diffusée en Open Source grâce au soutien de la
+[Nouvelle-Aquitaine Region](https://nouvelle-aquitaine.fr).
+
+# 🇬🇧 English
+
+## About Sinamet
+
+Sinamet is a Python library specialized in the analysis of territorialized
+flows and stocks\*. Sinamet supports database management through a specific data
+model. Using this model, it is possible to structure data of different themes,
+as long as they describe territorialized flows, for example:
+
+ * Freight transport statistics,
+ * Commuting statistics,
+ * Energy and water bill for a building,
+ * Orders from a catering establishment,
+ * Waste collection data,
+ * And many more!
+
+Sinamet includes functions to facilitate data navigation: organize object
+hierarchies, retrieve flows or stocks associated with a territory or a player,
+convert units or nomenclatures, track the temporality and source of data, etc.
+
+\*We also talk about studying "territorial metabolism". Sinamet stands for
+"Système d'Information pour l'ANalyse du MÉtabolisme des Territoires"
+
+## Documentation
+
+View online documentation: [https://docs.sinamet.tech](https://docs.sinamet.tech)
+
+## Contact
+
+Questions about the library ? Would you like to be trained to use the tool,
+or would you like to set up an observatory of flows in your area ?
+Contact the development team: libadmin@sinamet.tech
+
+## Credit
+
+Sinamet is a library developed by [Dynartio](https://dynartio.com), initiated
+thanks to funding from [ADEME](https://ademe.fr) and supports from
+[Laboratoire LIVE (University or Strasbourg/CNRS)](https://live.unistra.fr), and
+released as Open Source thanks to support from the
+[Nouvelle-Aquitaine Region](https://nouvelle-aquitaine.fr).

sinamet-0.0.1/README.md

@@ -0,0 +1,84 @@
+# 🇫🇷 Français
+
+## À propos de Sinamet
+
+Sinamet est une bibliothèque Python spécialisée pour l'analyse des flux et stocks
+territorialisés\*. Sinamet prend en charge la gestion d'une
+base de données à travers un modèle de données spécifique. À travers ce modèle,
+il est possible de structurer des données sur différentes thématiques,
+tant qu'elles décrivent des flux territorialisés, par exemple :
+
+ * Des statistiques sur le transport de marchandises,
+ * Des déplacements domicile-travail,
+ * Des factures d’énergie et d'eau d'un patrimoine bâti,
+ * Des commandes d'un établissement de restauration collective,
+ * Des données sur la collecte de déchets,
+ * Et plein d'autres !
+
+Sinamet embarque les fonctionnalités pour faciliter la navigation dans ces données :
+organiser des hiérarchies d'objets, récupérer des flux ou des stocks associés
+à un territoire ou un acteur, convertir des unités ou des nomenclatures,
+suivre la temporalité et la source des données, ...
+
+\*On parle également d'étudier le "métabolisme territorial".
+Sinamet est d'ailleurs l'acronyme de "Système d'Information pour l'ANalyse du
+MÉtabolisme des Territoires"
+
+## Documentation
+
+Consultez la documentation en ligne: [https://docs.sinamet.tech](https://docs.sinamet.tech)
+
+## Contact
+
+Des questions à propos de la bibliothèque ? Vous souhaitez être formé à
+l'utilisation de l'outil ou vous souhaitez mettre un observatoire des flux sur
+votre territoire ? Contactez l'équipe de développement : libadmin@sinamet.tech
+
+## Credit
+
+Sinamet est une bibliothèque développée par [Dynartio](https://dynartio.com),
+initiée grâce au financement de l'[ADEME](https://ademe.fr) et le soutien du
+[Laboratoire LIVE (University or Strasbourg/CNRS)](https://live.unistra.fr)
+et diffusée en Open Source grâce au soutien de la
+[Nouvelle-Aquitaine Region](https://nouvelle-aquitaine.fr).
+
+# 🇬🇧 English
+
+## About Sinamet
+
+Sinamet is a Python library specialized in the analysis of territorialized
+flows and stocks\*. Sinamet supports database management through a specific data
+model. Using this model, it is possible to structure data of different themes,
+as long as they describe territorialized flows, for example:
+
+ * Freight transport statistics,
+ * Commuting statistics,
+ * Energy and water bill for a building,
+ * Orders from a catering establishment,
+ * Waste collection data,
+ * And many more!
+
+Sinamet includes functions to facilitate data navigation: organize object
+hierarchies, retrieve flows or stocks associated with a territory or a player,
+convert units or nomenclatures, track the temporality and source of data, etc.
+
+\*We also talk about studying "territorial metabolism". Sinamet stands for
+"Système d'Information pour l'ANalyse du MÉtabolisme des Territoires"
+
+## Documentation
+
+View online documentation: [https://docs.sinamet.tech](https://docs.sinamet.tech)
+
+## Contact
+
+Questions about the library ? Would you like to be trained to use the tool,
+or would you like to set up an observatory of flows in your area ?
+Contact the development team: libadmin@sinamet.tech
+
+## Credit
+
+Sinamet is a library developed by [Dynartio](https://dynartio.com), initiated
+thanks to funding from [ADEME](https://ademe.fr) and supports from
+[Laboratoire LIVE (University or Strasbourg/CNRS)](https://live.unistra.fr), and
+released as Open Source thanks to support from the
+[Nouvelle-Aquitaine Region](https://nouvelle-aquitaine.fr).

sinamet-0.0.1/pyproject.toml

@@ -0,0 +1,59 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "sinamet"
+description = "Structuring data to analyze territorial flows."
+readme = "README.md"
+authors = [
+	{name = "Benoit Ribon", email = "b.ribon@dynartio.com"},
+	{email = "libadmin@sinamet.tech"},
+]
+license = {file = "LICENSE"}
+classifiers = [
+	"License :: OSI Approved :: MIT License",
+	"Programming Language :: Python",
+	"Programming Language :: Python :: 3.11",
+	"Programming Language :: Python :: 3.12",
+	"Programming Language :: Python :: 3.13",
+]
+requires-python = ">=3.11"
+dependencies = [
+	"anytree>=2.12.1",
+	"GeoAlchemy2>=0.16.0",
+	"numpy>=2.2.1",
+	"pandas>=2.2.3",
+	"psycopg2-binary>=2.9.10",
+	"shapely>=2.0.6",
+	"SQLAlchemy>=2.0.36",
+	"Unidecode>=1.3.8",
+]
+dynamic = ["version"]
+
+[project.urls]
+Documentation = "https://docs.sinamet.tech"
+"Source Code" = "https://github.com/dynartIO/sinamet"
+
+[project.optional-dependencies]
+demo = [
+	"geopandas>=1.0.1",
+	"xlrd>=2.0.1",
+	"openpyxl>=3.1.5",
+]
+
+mkdocs = [
+	"mkdocs",
+	"mkdocstrings[python]",
+	"mkdocs-material",
+	"black",
+]
+
+[tool.hatch.version]
+path = "src/sinamet/__init__.py"
+
+[tool.hatch.build.targets.sdist]
+exclude = [
+	"docs/",
+	"mkdocs.yml",
+]

sinamet-0.0.1/src/sinamet/__init__.py

@@ -0,0 +1,17 @@
+from .core.mapper import Mapper
+from .core.mapper import MapperError
+
+from .core.config import config
+
+from .sidb import Sidb
+
+from .mtobjects import MTObject
+from .mtobjects import Territory
+from .mtobjects import Actor
+from .mtobjects import Product
+from .mtobjects import Pathflow
+from .mtobjects import Gateflow
+from .mtobjects import Stock
+from .mtobjects import Property
+
+__version__ = '0.0.1'

sinamet-0.0.1/src/sinamet/core/config.py

@@ -0,0 +1,154 @@
+import os
+
+from pathlib import Path
+
+import tomllib
+
+from typing import Any
+
+
+class SinametConfig:
+    def __init__(self):
+        self.current_environref: str = "_"
+        self.configs: dict[str, dict[str, str]] = {}
+        self.config_file: dict[str, Any] = self.init_config_file()
+
+    def __getitem__(self, key: str) -> str:
+        try:
+            return self.configs[self.current_environref][key]
+        except KeyError:
+            return self.configs["_"][key]
+
+    def __setitem__(self, key: str, value: str):
+        if self.current_environref not in self.configs:
+            self.configs[self.current_environref] = {}
+        self.configs[self.current_environref][key] = value
+
+    def __contains__(self, item: str):
+        if self.current_environref not in self.configs:
+            return False
+        return item in self.configs[self.current_environref]
+
+    def init_key(self,
+                 key: str,
+                 value: str | None = None,
+                 environref: str | None = None,
+                 verbose: bool = False) -> str | None:
+        if not environref:
+            environref = self.current_environref
+        if environref not in self.configs:
+            self.configs[environref] = {}
+        if value is None:
+            value = self.find_key(key, environref, verbose=verbose)
+        if value or not self.configs[environref].get(key):
+            self.configs[environref][key] = value
+        return value
+
+    def init_db(self,
+                environref: str | None = None,
+                verbose: bool = False,
+                **kwargs) -> None:
+        if not environref:
+            environref = self.current_environref
+        if environref not in self.configs:
+            self.configs[environref] = {}
+
+        coredb_path = self.find_key('COREDB_PATH', environref, kwargs, verbose)
+        if coredb_path:
+            if verbose:
+                print(f"COREDB_PATH='{coredb_path}'")
+            self.configs[environref]['COREDB_PATH'] = coredb_path
+            return coredb_path
+
+        keys = [
+                "COREDB_NAME",
+                "COREDB_USER",
+                "COREDB_PASS",
+                "COREDB_HOST",
+                "COREDB_PORT",
+        ]
+        for key in keys:
+            value = self.find_key(key, environref, kwargs, verbose)
+            if value is not None:
+                self.configs[environref][key] = value
+            if not self.configs[environref].get(key):
+                raise KeyError(f"Could not find a value for {key}.")
+
+        coredb_path = ("postgresql://"
+                       f"{self.configs[environref]['COREDB_USER']}"
+                       f":{self.configs[environref]['COREDB_PASS']}"
+                       f"@{self.configs[environref]['COREDB_HOST']}"
+                       f":{self.configs[environref]['COREDB_PORT']}"
+                       f"/{self.configs[environref]['COREDB_NAME']}")
+        self.configs[environref]["COREDB_PATH"] = coredb_path
+
+        if verbose:
+            print(f"COREDB_PATH='{coredb_path}'")
+        return coredb_path
+
+    def find_key(self,
+                 key: str,
+                 environref: str,
+                 kwargs: dict = {},
+                 verbose: bool = False
+                 ) -> str | None:
+        """
+        Ordre de priorité de recherche:
+            - kwargs -> sans prefix ET sans environref
+            - os.environ -> avec prefix ET avec ou sans environref
+            - config file -> avec ou sans environref
+        """
+        if verbose:
+            print(f"find_key: {key=}")
+            print(">>>>> ", end="")
+
+        # Search in kwargs
+        if value := kwargs.get(key):
+            if verbose:
+                print(f"in kwargs: {key}='{value}'")
+            return value
+
+        # Search in environment variables
+        if value := os.getenv(f"SINAMET_{key}_{environref}"):
+            if verbose:
+                print(f"in os.environ: SINAMET_{key}_{environref}='{value}'")
+            return value
+        if value := os.getenv(f"SINAMET_{key}"):
+            if verbose:
+                print(f"in os.environ: SINAMET_{key}='{value}'")
+            return value
+
+        # Search in config file
+        current_env = os.getenv('SINAMET_CURRENT_ENV') or self.config_file.get('current_env')
+        if current_env in self.config_file:
+            if (value := self.config_file[current_env].get(key)):
+                if verbose:
+                    print(f"in config file in {current_env} table: {key}='{value}'")
+                return value
+        if value := self.config_file.get(key):
+            if verbose:
+                print(f"in config file: {key}='{value}'")
+            return value
+        if verbose:
+            print(f"Key '{key}' not found.")
+
+    @staticmethod
+    def init_config_file() -> dict[str, Any]:
+        """
+        Note: FutureDev
+            Envisager une recherche avec des chemins absolus ou $PYTHONPATH.
+        """
+        path = Path.cwd()
+        while path != path.parent:
+            config_path = path / 'sinamet_config.toml'
+            path = path.parent
+
+            if not config_path.is_file() or not os.access(config_path, os.R_OK):
+                continue
+
+            with open(config_path, 'rb') as f:
+                return tomllib.load(f)
+        return {}
+
+
+config = SinametConfig()