SIRI-lite

Dhrions Version 0.5.0, 12/08/2026

Outil Python pour interroger des API de transport en commun compatibles SIRI-lite

Documentation · 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
• ✨ Fonctionnalités principales
• 🚀 Installation rapide
• 💻 Utilisation (CLI)
• 📦 Utilisation avec Docker
• 🧪 Tests
• 🏗️ Architecture
• 📚 Documentation complète
• ⚠️ Sécurité
• 📄 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

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 :

siri-lite stop-monitoring \
  --service CTS \
  --stop-code 43A \
  --token YOUR_TOKEN \
  --print

Exemple avec PRIM :

siri-lite stop-monitoring \
  --service PRIM \
  --stop-code STIF%3AStopPoint%3AQ%3A473921%3A \
  --token YOUR_TOKEN \
  --print

Options

Recherche d'arrêts PRIM

# Backend static (défaut) : sans token, métadonnées seulement
siri-lite stops-discovery "Châtelet" --print

# Backend icar (recommandé) : token requis, MonitoringRef candidat
siri-lite stops-discovery "Châtelet" --backend icar --token "$PRIM_TOKEN" --print

⚠️ Le backend static aide à retrouver un arrêt PRIM (nom, commune, lignes) sans code garanti utilisable avec stop-monitoring. Le backend icar affiche un MonitoringRef candidat (même espace d'identifiants que SIRI, vérifié empiriquement), mais son premier appel télécharge ~120 Mo (~30 s, pas de recherche par nom côté API ICAR). Voir la documentation Antora (PRIM → Arrêts) pour le détail.

📦 Utilisation avec Docker

docker build -t siri-lite .
docker run --env-file .env siri-lite stop-monitoring \
  --service CTS \
  --stop-code 43A \
  --token YOUR_TOKEN

🧪 Tests

# 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, + aiohttp pour le stop-monitoring)
├── config.py          # Chargement configuration
├── main.py            # Point d'entrée
└── logging_config.py  # Configuration du logging

Chemin async (stop-monitoring uniquement)

APIRequest/SiriClient exposent, en plus de leurs méthodes synchrones existantes (requests), un chemin async équivalent basé sur aiohttp : APIRequest.async_get_response(session) et SiriClient.async_fetch_next_calls(session) / async_fetch_next_call(session). Ce chemin :

• reste limité au stop-monitoring (les autres appels réseau — découverte d'arrêts, résolution de nom de ligne — restent synchrones, requests uniquement) ;
• attend une aiohttp.ClientSession fournie par l'appelant (ex. async_get_clientsession(hass) côté Home Assistant) — la lib n'en crée ni n'en ferme aucune ; lève aiohttp.ClientError (pas requests.exceptions.RequestException, propre à ce chemin).

async with aiohttp.ClientSession() as session:
    client = SiriClient(url=url, headers=headers, auth=auth)
    calls = await client.async_fetch_next_calls(session)

📚 Documentation complète

La documentation détaillée (architecture, services supportés, exemples, intégration Home Assistant, etc.) est disponible via Antora :

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.