siri-lite 0.6.0__tar.gz

siri_lite-0.6.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-2026 Dhrions
+
+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.

siri_lite-0.6.0/MANIFEST.in

@@ -0,0 +1,16 @@
+include README.md
+include LICENSE
+include services.conf
+
+exclude .env.example
+exclude .secrets
+exclude .gitleaksignore
+exclude digest.txt
+exclude main.log
+exclude exchange-with-cts.eml
+exclude siri-lite.png
+recursive-exclude node_modules *
+recursive-exclude build *
+prune .gitea
+prune docs
+prune tests

siri_lite-0.6.0/PKG-INFO

@@ -0,0 +1,221 @@
+Metadata-Version: 2.4
+Name: siri-lite
+Version: 0.6.0
+Summary: CLI and library to query SIRI-lite public transport APIs
+Author-email: Dhrions <aturing@laposte.net>
+License: MIT
+Project-URL: Homepage, https://github.com/dhrions/siri-lite
+Project-URL: Repository, https://github.com/dhrions/siri-lite
+Project-URL: Issues, https://github.com/dhrions/siri-lite/issues
+Project-URL: Documentation, https://docs.dhrions.fr/dhrions/siri-lite/
+Keywords: siri,siri-lite,transport,real-time,public-transit,cli
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.1
+Requires-Dist: requests>=2.32
+Requires-Dist: python-dateutil>=2.9
+Requires-Dist: Flask>=3.1
+Provides-Extra: dev
+Requires-Dist: pytest>=8.3; extra == "dev"
+Requires-Dist: pytest-mock>=3.14; extra == "dev"
+Requires-Dist: responses>=0.25; extra == "dev"
+Requires-Dist: coverage>=7.6; extra == "dev"
+Requires-Dist: python-semantic-release<10,>=9; extra == "dev"
+Dynamic: license-file
+
+![SIRI-lite](siri-lite.png)
+
+# SIRI-lite
+
+Dhrions
+Version 0.5.0, 12/08/2026
+
+> Outil Python pour interroger des API de transport en commun compatibles SIRI-lite
+
+[Documentation](https://docs.dhrions.fr/dhrions/siri-lite/) · [Issues](https://gitea.dhrions.fr/dhrions/siri-lite/issues)
+
+## ⚡ TL;DR
+
+- 🚌 Interroge des API de transport en commun compatibles SIRI-lite pour les prochains passages et le temps restant avant arrivée
+- 🎯 Pour qui : usage personnel, intégrations (ex. Home Assistant)
+- 🚀 `siri-lite stop-monitoring --service CTS --stop-code 43A --token YOUR_TOKEN --print`
+
+Le projet fournit :
+- 🖥️ une **CLI** (ligne de commande),
+- 🌐 une **interface web minimale** (Flask),
+- 🔗 une base solide pour des intégrations (ex. Home Assistant).
+
+## 📋 Table des matières
+
+- [⚡ TL;DR](#-tldr)
+- [✨ Fonctionnalités principales](#-fonctionnalités-principales)
+- [🚀 Installation rapide](#-installation-rapide)
+- [💻 Utilisation (CLI)](#-utilisation-cli)
+- [📦 Utilisation avec Docker](#-utilisation-avec-docker)
+- [🧪 Tests](#-tests)
+- [🏗️ Architecture](#️-architecture)
+- [📚 Documentation complète](#-documentation-complète)
+- [⚠️ Sécurité](#️-sécurité)
+- [📄 Licence](#-licence)
+
+---
+
+## ✨ Fonctionnalités principales
+
+- ⏱️ Récupération du **temps restant avant l'arrivée** d'un véhicule à un arrêt
+- 🚌 Support de plusieurs réseaux (ex. **CTS**, **PRIM / Île-de-France Mobilités**)
+- 📤 Sortie console, fichier JSON ou intégration applicative
+- 📦 Exécution locale ou via **Docker**
+- 📚 Documentation complète générée avec **Antora**
+
+---
+
+## 🚀 Installation rapide
+
+### Environnement Python
+
+```bash
+python3 -m venv venv
+source venv/bin/activate
+pip install -e ".[dev]"
+```
+
+### Configuration
+
+Copier `.env.example` vers `.env` (fichier réellement ignoré par git, contrairement à
+`.env.example` qui n'est qu'un gabarit) et y renseigner les paramètres du service utilisé :
+
+```
+CTS_BASE_API_URL=https://api.cts-strasbourg.eu/
+CTS_AUTH_METH=Basic Auth
+PRIM_BASE_API_URL=https://prim.iledefrance-mobilites.fr/
+PRIM_AUTH_METH=apiKey
+STOP_MONITORING_ENDPOINT=siri/2.0/stop-monitoring?MonitoringRef=
+```
+
+Ces mêmes valeurs peuvent aussi être fournies via `services.conf`, résolu en suivant la
+spec XDG Base Directory (`--config`, puis `$XDG_CONFIG_HOME/siri-lite/`, puis
+`~/.siri-lite/`, puis le répertoire courant) — voir la documentation Antora pour le
+détail. Les tokens, eux, **ne doivent jamais être commités** ; ils se passent via
+`--token` (CLI) ou `{SERVICE}_TOKEN` (interface web, ex. `CTS_TOKEN` ou `PRIM_TOKEN`
+selon le paramètre `?service=`).
+
+---
+
+## 💻 Utilisation (CLI)
+
+Exemple avec le service CTS :
+
+```bash
+siri-lite stop-monitoring \
+  --service CTS \
+  --stop-code 43A \
+  --token YOUR_TOKEN \
+  --print
+```
+
+Exemple avec PRIM :
+
+```bash
+siri-lite stop-monitoring \
+  --service PRIM \
+  --stop-code STIF%3AStopPoint%3AQ%3A473921%3A \
+  --token YOUR_TOKEN \
+  --print
+```
+
+### Options
+
+| Option | Description |
+|---|---|
+| `--service` | Réseau de transport (`CTS` ou `PRIM`) |
+| `--stop-code` | Code de l'arrêt à interroger |
+| `--token` | Token d'authentification de l'API |
+| `--print` | Affiche le résultat sur la sortie standard |
+| `--unit` | Unité du temps restant (`minutes` ou `seconds`, défaut `minutes`) |
+| `-c`, `--count` | Nombre de prochains passages à afficher (défaut `1` : un entier ; au-delà, une liste) |
+| `-o`, `--output` | Écrit le résultat au format JSON dans le fichier indiqué |
+| `--config` | Chemin explicite vers `services.conf` (voir section Configuration ci-dessus) |
+| `-d`, `--debug` | Active les logs de debug |
+
+---
+
+## 📦 Utilisation avec Docker
+
+```bash
+docker build -t siri-lite .
+docker run --env-file .env siri-lite stop-monitoring \
+  --service CTS \
+  --stop-code 43A \
+  --token YOUR_TOKEN
+```
+
+---
+
+## 🧪 Tests
+
+```bash
+# Tous les tests
+pytest tests/
+
+# Un fichier spécifique
+pytest tests/test_models.py
+
+# Avec couverture
+coverage run -m pytest tests/ && coverage report
+```
+
+---
+
+## 🏗️ Architecture
+
+Structure plate et simple :
+
+```
+src/siri_lite/
+├── cli.py             # Commandes CLI (Click)
+├── web.py             # Interface web (Flask)
+├── services.py        # Logique métier
+├── siri_client.py     # Client API SIRI + parsing
+├── models.py          # Modèles de données (DTOs)
+├── http_client.py     # Client HTTP générique (requests)
+├── config.py          # Chargement configuration
+├── main.py            # Point d'entrée
+└── logging_config.py  # Configuration du logging
+```
+
+---
+
+## 📚 Documentation complète
+
+La **documentation détaillée** (architecture, services supportés, exemples, intégration Home Assistant, etc.) est disponible via **Antora** :
+
+```bash
+antora antora-playbook.yml
+```
+
+Sources de la documentation : `docs/`
+
+---
+
+## ⚠️ Sécurité
+
+- Les fichiers `.env` et `.secrets` **ne doivent jamais être versionnés**
+- Les tokens visibles dans l'historique doivent être considérés comme compromis et régénérés
+
+---
+
+## 📄 Licence
+
+Projet personnel – licence à définir.

siri_lite-0.6.0/README.md

@@ -0,0 +1,185 @@
+![SIRI-lite](siri-lite.png)
+
+# SIRI-lite
+
+Dhrions
+Version 0.5.0, 12/08/2026
+
+> Outil Python pour interroger des API de transport en commun compatibles SIRI-lite
+
+[Documentation](https://docs.dhrions.fr/dhrions/siri-lite/) · [Issues](https://gitea.dhrions.fr/dhrions/siri-lite/issues)
+
+## ⚡ TL;DR
+
+- 🚌 Interroge des API de transport en commun compatibles SIRI-lite pour les prochains passages et le temps restant avant arrivée
+- 🎯 Pour qui : usage personnel, intégrations (ex. Home Assistant)
+- 🚀 `siri-lite stop-monitoring --service CTS --stop-code 43A --token YOUR_TOKEN --print`
+
+Le projet fournit :
+- 🖥️ une **CLI** (ligne de commande),
+- 🌐 une **interface web minimale** (Flask),
+- 🔗 une base solide pour des intégrations (ex. Home Assistant).
+
+## 📋 Table des matières
+
+- [⚡ TL;DR](#-tldr)
+- [✨ Fonctionnalités principales](#-fonctionnalités-principales)
+- [🚀 Installation rapide](#-installation-rapide)
+- [💻 Utilisation (CLI)](#-utilisation-cli)
+- [📦 Utilisation avec Docker](#-utilisation-avec-docker)
+- [🧪 Tests](#-tests)
+- [🏗️ Architecture](#️-architecture)
+- [📚 Documentation complète](#-documentation-complète)
+- [⚠️ Sécurité](#️-sécurité)
+- [📄 Licence](#-licence)
+
+---
+
+## ✨ Fonctionnalités principales
+
+- ⏱️ Récupération du **temps restant avant l'arrivée** d'un véhicule à un arrêt
+- 🚌 Support de plusieurs réseaux (ex. **CTS**, **PRIM / Île-de-France Mobilités**)
+- 📤 Sortie console, fichier JSON ou intégration applicative
+- 📦 Exécution locale ou via **Docker**
+- 📚 Documentation complète générée avec **Antora**
+
+---
+
+## 🚀 Installation rapide
+
+### Environnement Python
+
+```bash
+python3 -m venv venv
+source venv/bin/activate
+pip install -e ".[dev]"
+```
+
+### Configuration
+
+Copier `.env.example` vers `.env` (fichier réellement ignoré par git, contrairement à
+`.env.example` qui n'est qu'un gabarit) et y renseigner les paramètres du service utilisé :
+
+```
+CTS_BASE_API_URL=https://api.cts-strasbourg.eu/
+CTS_AUTH_METH=Basic Auth
+PRIM_BASE_API_URL=https://prim.iledefrance-mobilites.fr/
+PRIM_AUTH_METH=apiKey
+STOP_MONITORING_ENDPOINT=siri/2.0/stop-monitoring?MonitoringRef=
+```
+
+Ces mêmes valeurs peuvent aussi être fournies via `services.conf`, résolu en suivant la
+spec XDG Base Directory (`--config`, puis `$XDG_CONFIG_HOME/siri-lite/`, puis
+`~/.siri-lite/`, puis le répertoire courant) — voir la documentation Antora pour le
+détail. Les tokens, eux, **ne doivent jamais être commités** ; ils se passent via
+`--token` (CLI) ou `{SERVICE}_TOKEN` (interface web, ex. `CTS_TOKEN` ou `PRIM_TOKEN`
+selon le paramètre `?service=`).
+
+---
+
+## 💻 Utilisation (CLI)
+
+Exemple avec le service CTS :
+
+```bash
+siri-lite stop-monitoring \
+  --service CTS \
+  --stop-code 43A \
+  --token YOUR_TOKEN \
+  --print
+```
+
+Exemple avec PRIM :
+
+```bash
+siri-lite stop-monitoring \
+  --service PRIM \
+  --stop-code STIF%3AStopPoint%3AQ%3A473921%3A \
+  --token YOUR_TOKEN \
+  --print
+```
+
+### Options
+
+| Option | Description |
+|---|---|
+| `--service` | Réseau de transport (`CTS` ou `PRIM`) |
+| `--stop-code` | Code de l'arrêt à interroger |
+| `--token` | Token d'authentification de l'API |
+| `--print` | Affiche le résultat sur la sortie standard |
+| `--unit` | Unité du temps restant (`minutes` ou `seconds`, défaut `minutes`) |
+| `-c`, `--count` | Nombre de prochains passages à afficher (défaut `1` : un entier ; au-delà, une liste) |
+| `-o`, `--output` | Écrit le résultat au format JSON dans le fichier indiqué |
+| `--config` | Chemin explicite vers `services.conf` (voir section Configuration ci-dessus) |
+| `-d`, `--debug` | Active les logs de debug |
+
+---
+
+## 📦 Utilisation avec Docker
+
+```bash
+docker build -t siri-lite .
+docker run --env-file .env siri-lite stop-monitoring \
+  --service CTS \
+  --stop-code 43A \
+  --token YOUR_TOKEN
+```
+
+---
+
+## 🧪 Tests
+
+```bash
+# Tous les tests
+pytest tests/
+
+# Un fichier spécifique
+pytest tests/test_models.py
+
+# Avec couverture
+coverage run -m pytest tests/ && coverage report
+```
+
+---
+
+## 🏗️ Architecture
+
+Structure plate et simple :
+
+```
+src/siri_lite/
+├── cli.py             # Commandes CLI (Click)
+├── web.py             # Interface web (Flask)
+├── services.py        # Logique métier
+├── siri_client.py     # Client API SIRI + parsing
+├── models.py          # Modèles de données (DTOs)
+├── http_client.py     # Client HTTP générique (requests)
+├── config.py          # Chargement configuration
+├── main.py            # Point d'entrée
+└── logging_config.py  # Configuration du logging
+```
+
+---
+
+## 📚 Documentation complète
+
+La **documentation détaillée** (architecture, services supportés, exemples, intégration Home Assistant, etc.) est disponible via **Antora** :
+
+```bash
+antora antora-playbook.yml
+```
+
+Sources de la documentation : `docs/`
+
+---
+
+## ⚠️ Sécurité
+
+- Les fichiers `.env` et `.secrets` **ne doivent jamais être versionnés**
+- Les tokens visibles dans l'historique doivent être considérés comme compromis et régénérés
+
+---
+
+## 📄 Licence
+
+Projet personnel – licence à définir.

siri_lite-0.6.0/pyproject.toml

@@ -0,0 +1,83 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "siri-lite"
+version = "0.6.0"
+description = "CLI and library to query SIRI-lite public transport APIs"
+readme = "README.md"
+requires-python = ">=3.9"
+license = { text = "MIT" }
+
+authors = [
+    { name = "Dhrions", email = "aturing@laposte.net" }
+]
+keywords = ["siri", "siri-lite", "transport", "real-time", "public-transit", "cli"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+
+dependencies = [
+    "click>=8.1",
+    "requests>=2.32",
+    "python-dateutil>=2.9",
+    "Flask>=3.1",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.3",
+    "pytest-mock>=3.14",
+    "responses>=0.25",
+    "coverage>=7.6",
+    "python-semantic-release>=9,<10",
+]
+
+[project.scripts]
+siri-lite = "siri_lite.cli:cli"
+
+[project.urls]
+Homepage = "https://github.com/dhrions/siri-lite"
+Repository = "https://github.com/dhrions/siri-lite"
+Issues = "https://github.com/dhrions/siri-lite/issues"
+Documentation = "https://docs.dhrions.fr/dhrions/siri-lite/"
+
+[tool.setuptools]
+package-dir = { "" = "src" }
+packages = ["siri_lite"]
+
+[tool.semantic_release]
+version_toml = ["pyproject.toml:project.version"]
+version_variables = ["src/siri_lite/__init__.py:__version__"]
+branch = "master"
+# Les commits de ce dépôt sont en gitmoji (`✨ feat(cli): …`). Le parser "angular" ne
+# sait pas lire un en-tête préfixé d'un emoji : aucun bump détecté, aucune erreur
+# remontée, la release passe au vert sans rien faire. Voir
+# repos-meta/SEMANTIC_RELEASE_ALIGNMENT.md.
+commit_parser = "emoji"
+major_on_zero = false
+tag_format = "v{version}"
+# [skip ci] : évite que le commit de release redéclenche un run.
+commit_message = "🔖 chore(release): {version} [skip ci]"
+
+[tool.semantic_release.commit_parser_options]
+major_tags = ["💥"]
+minor_tags = ["✨"]
+patch_tags = ["🐛", "🚑", "⚡", "🔒"]
+
+[tool.semantic_release.changelog]
+exclude_commit_patterns = []
+
+[tool.semantic_release.branches.master]
+match = "master"
+prerelease = false

siri_lite-0.6.0/services.conf

@@ -0,0 +1,12 @@
+# Configuration des services SIRI-lite
+
+[CTS]
+base_url = https://api.cts-strasbourg.eu/v1/siri/2.0/
+auth_method = Basic Auth
+
+[PRIM]
+base_url = https://prim.iledefrance-mobilites.fr/marketplace/
+auth_method = apiKey
+
+[endpoints]
+stop_monitoring = stop-monitoring?MonitoringRef=

siri_lite-0.6.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

siri_lite-0.6.0/src/siri_lite/__init__.py

@@ -0,0 +1,3 @@
+"""SIRI-lite - CLI and library to query SIRI-lite public transport APIs."""
+
+__version__ = "0.6.0"

siri_lite-0.6.0/src/siri_lite/cli.py

@@ -0,0 +1,65 @@
+"""Command-line interface."""
+
+import json
+import logging
+import click
+import requests
+
+from siri_lite import __version__
+from siri_lite.config import load_env, get_stop_monitoring_endpoint
+from siri_lite.siri_client import SiriClient
+from siri_lite.services import get_remaining_times
+
+logger = logging.getLogger("main")
+
+
+@click.group()
+@click.version_option(version=__version__, prog_name="siri-lite")
+def cli():
+    """SIRI-lite CLI for public transport information."""
+    pass
+
+
+@cli.command()
+@click.option("--service", type=click.Choice(["CTS", "PRIM"]), required=True)
+@click.option("--stop-code", required=True)
+@click.option("--token", required=True)
+@click.option("--print", "do_print", is_flag=True)
+@click.option("--unit", type=click.Choice(["minutes", "seconds"]), default="minutes")
+@click.option("-c", "--count", type=click.IntRange(min=1), default=1,
+              help="Number of upcoming passages to display.")
+@click.option("-o", "--output", type=click.Path())
+@click.option("-d", "--debug", is_flag=True)
+@click.option("--config", type=click.Path(), default=None,
+              help="Path to services.conf (default: $XDG_CONFIG_HOME/siri-lite/services.conf).")
+def stop_monitoring(service, stop_code, token, do_print, unit, count, output, debug, config):
+    """Display the remaining time for a given stop code."""
+    logger.setLevel(logging.DEBUG if debug else logging.INFO)
+
+    try:
+        base_api_url, headers, auth = load_env(service, token, config_path=config)
+
+        endpoint = get_stop_monitoring_endpoint(config_path=config)
+        url = base_api_url + endpoint + stop_code
+
+        siri_client = SiriClient(url=url, headers=headers, auth=auth)
+        remaining_times = get_remaining_times(siri_client, count=count, unit=unit)
+    except (ValueError, requests.exceptions.RequestException) as error:
+        click.echo(f"❌ {error}", err=True)
+        raise SystemExit(1) from error
+
+    if not remaining_times:
+        click.echo("⚠️ Aucun passage disponible pour le moment.")
+        return None
+
+    result = remaining_times[0] if count == 1 else remaining_times
+
+    if output:
+        with open(output, "w") as file:
+            json.dump(result, file, indent=4)
+        click.echo(f"✅ Résultat écrit dans {output}")
+
+    if do_print:
+        click.echo(result)
+
+    return result