pax_global_header00006660000000000000000000000064145510640220014511gustar00rootroot0000000000000052 comment=9031574091914b77e8f6b89b3c0df275d5f9854c ratp-api-python-1.0.3/000077500000000000000000000000001455106402200145465ustar00rootroot00000000000000ratp-api-python-1.0.3/.github/000077500000000000000000000000001455106402200161065ustar00rootroot00000000000000ratp-api-python-1.0.3/.github/workflows/000077500000000000000000000000001455106402200201435ustar00rootroot00000000000000ratp-api-python-1.0.3/.github/workflows/python-publish.yml000066400000000000000000000022101455106402200236460ustar00rootroot00000000000000# This workflow will upload a Python Package using Twine when a release is created # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries # This workflow uses actions that are not certified by GitHub. # They are provided by a third-party and are governed by # separate terms of service, privacy policy, and support # documentation. name: Upload Python Package on: release: types: [published] permissions: contents: read jobs: deploy: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - name: Set up Python uses: actions/setup-python@v3 with: python-version: '3.x' - name: Install dependencies run: | python -m pip install --upgrade pip pip install build pip install wheel pip install setuptools - name: Build package run: python3 setup.py sdist bdist_wheel - name: Publish package uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29 with: user: __token__ password: ${{ secrets.PYPI_API_TOKEN }} ratp-api-python-1.0.3/.gitignore000066400000000000000000000037701455106402200165450ustar00rootroot00000000000000# Byte-compiled / optimized / DLL files __pycache__/ *.py[cod] *$py.class # C extensions *.so # Distribution / packaging .idea .Python build/ develop-eggs/ dist/ downloads/ eggs/ .eggs/ lib/ lib64/ parts/ sdist/ var/ wheels/ share/python-wheels/ *.egg-info/ .installed.cfg *.egg MANIFEST # PyInstaller # Usually these files are written by a python script from a template # before PyInstaller builds the exe, so as to inject date/other infos into it. *.manifest *.spec # Installer logs pip-log.txt pip-delete-this-directory.txt # Unit test / coverage reports htmlcov/ .tox/ .nox/ .coverage .coverage.* .cache nosetests.xml coverage.xml *.cover *.py,cover .hypothesis/ .pytest_cache/ cover/ # Translations *.mo *.pot # Django stuff: *.log local_settings.py db.sqlite3 db.sqlite3-journal # Flask stuff: instance/ .webassets-cache # Scrapy stuff: .scrapy # Sphinx documentation docs/_build/ # PyBuilder .pybuilder/ target/ # Jupyter Notebook .ipynb_checkpoints # IPython profile_default/ ipython_config.py # pyenv # For a library or package, you might want to ignore these files since the code is # intended to run in multiple environments; otherwise, check them in: # .python-version # pipenv # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. # However, in case of collaboration, if having platform-specific dependencies or dependencies # having no cross-platform support, pipenv may install dependencies that don't work, or not # install all needed dependencies. #Pipfile.lock # PEP 582; used by e.g. github.com/David-OConnor/pyflow __pypackages__/ # Celery stuff celerybeat-schedule celerybeat.pid # SageMath parsed files *.sage.py # Environments .env .venv env/ venv/ ENV/ env.bak/ venv.bak/ # Spyder project settings .spyderproject .spyproject # Rope project settings .ropeproject # mkdocs documentation /site # mypy .mypy_cache/ .dmypy.json dmypy.json # Pyre type checker .pyre/ # pytype static type analyzer .pytype/ # Cython debug symbols cython_debug/ratp-api-python-1.0.3/README.md000066400000000000000000000052541455106402200160330ustar00rootroot00000000000000# RatpAPI Python Wrapper ## Overview RatpAPI is a Python wrapper for interacting with the RATP (Régie Autonome des Transports Parisiens) API. This library provides easy access to real-time traffic information, line-specific traffic details, and affluence data for journeys on the RATP network in Paris. ## Features - Fetch global traffic information on the RATP network. - Retrieve traffic information for specific lines using the `LineID` enum for easy reference. - Get affluence data for journeys on particular lines. - Utilizes Pydantic models for data validation and parsing. ## Installation To use RatpAPI in your project, you can install it via pip: ```bash pip install ratp-api-python ``` ## Usage a ### Setting Up First, import the `RatpAPI` class and initialize it with your API key: ```python from ratp_api.main import RatpAPI api = RatpAPI() ``` ### Using the LineID Enum The `LineID` enum provides a convenient way to reference specific lines by their IDs: ```python from ratp_api.enums import LineID # Example: Using LineID for RER A line_id = LineID.RER_A ``` ### Fetching Global Traffic Information To get global traffic data: ```python global_traffic = api.get_global_traffic() print(global_traffic) ``` ### Fetching Line-Specific Traffic To get traffic information for a specific line using the `LineID` enum: ```python line_data = api.get_line_traffic(line_id=LineID.METRO_14) for situation in line_data.situations: print(situation) # Output: # isActive=True isPlanned=True criticity='HIGH' messages=["Jusqu'au 04/02, le week-end, trafic interrompu sur l'ensemble de la ligne en raison de travaux. Bus de remplacement. Plus d'informations sur la page dédiée."] # isActive=False isPlanned=True criticity='HIGH' messages=["Du 01/02 au 08/02, du lundi au jeudi à partir de 22h, trafic interrompu sur l'ensemble de la ligne en raison de travaux. Bus de remplacement. Plus d'informations sur la page dédiée."] # isActive=False isPlanned=True criticity='HIGH' messages=["Jusqu'au 31/01, du lundi au jeudi à partir de 22h, trafic interrompu sur l'ensemble de la ligne en raison de travaux. Bus de remplacement. Plus d'informations sur la page dédiée."] ``` ### Fetching Affluence for Journeys To get affluence data for a specific journey on a line: ```python line_id = LineID.RER_A # Using LineID enum affluence_data = api.get_line_affluence(line_id=line_id) print(affluence_data) ``` ### Fetching Affluence for All Lines To get affluence data for all lines: ```python all_lines_affluence = api.get_all_lines_affluence() print(all_lines_affluence) ``` ## Contributing Contributions to the RatpAPI project are welcomed! ## License This project is licensed under the MIT License. ---ratp-api-python-1.0.3/pyproject.toml.toml000066400000000000000000000005561455106402200204420ustar00rootroot00000000000000[build-system] requires = ["poetry-core>=1.0.0"] build-backend = "poetry.core.masonry.api" [tool.poetry] name = "ratp_api" version = "0.1.0" description = "Get data from the RATP API" authors = ["Romeo Phillips"] [tool.poetry.dependencies] python = "^3.7" certifi = "2023.7.22" requests = "2.31.0" pydantic = "2.5.3" wheel = "0.41.2" [build] script = "build.py" ratp-api-python-1.0.3/requirements.txt000066400000000000000000000000671455106402200200350ustar00rootroot00000000000000requests==2.31.0 setuptools~=65.5.1 pydantic~=2.5.3 ```ratp-api-python-1.0.3/setup.cfg000066400000000000000000000001071455106402200163650ustar00rootroot00000000000000[metadata] version = attr: ratp_api.__version__ license_files = LICENSEratp-api-python-1.0.3/setup.py000066400000000000000000000027411455106402200162640ustar00rootroot00000000000000import setuptools with open("README.md", "r", encoding="utf-8") as fh: long_description = fh.read() setuptools.setup( name="ratp_api", author="Roméo Phillips", author_email="phillipsromeo@gmail.com", description="Get RATP data from RATP API.", keywords="ratp, rer, metro, api, ratp_api, ratp_api-python", long_description=long_description, long_description_content_type="text/markdown", url="https://github.com/tomchen/example_pypi_package", project_urls={ "Documentation": "https://github.com/Strvm/ratp-api-python", "Bug Reports": "https://github.com/Strvm/ratp-api-python", "Source Code": "https://github.com/Strvm/ratp-api-python", }, package_dir={"": "src"}, packages=setuptools.find_packages(where="src"), classifiers=[ "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "Topic :: Software Development :: Build Tools", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3 :: Only", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", ], python_requires=">=3.6", extras_require={ "dev": ["check-manifest"], }, install_requires=["requests", "pydantic"], ) ratp-api-python-1.0.3/src/000077500000000000000000000000001455106402200153355ustar00rootroot00000000000000ratp-api-python-1.0.3/src/ratp_api/000077500000000000000000000000001455106402200171345ustar00rootroot00000000000000ratp-api-python-1.0.3/src/ratp_api/__init__.py000066400000000000000000000000531455106402200212430ustar00rootroot00000000000000__version__ = "1.0.3" from .main import * ratp-api-python-1.0.3/src/ratp_api/affluence/000077500000000000000000000000001455106402200210645ustar00rootroot00000000000000ratp-api-python-1.0.3/src/ratp_api/affluence/__init__.py000066400000000000000000000000001455106402200231630ustar00rootroot00000000000000ratp-api-python-1.0.3/src/ratp_api/affluence/line_mappings.py000066400000000000000000000076661455106402200243020ustar00rootroot00000000000000line_end_points = { "1": { "start": { "name": "La Défense", "coords": (2.237018056395013, 48.89218707551516), }, "end": { "name": "Château de Vincennes", "coords": (2.440439978057246, 48.844456393634566), }, }, "2": { "start": { "name": "Porte Dauphine", "coords": (2.277083018415724, 48.87146657720145), }, "end": {"name": "Nation", "coords": (2.395554512170687, 48.84757936654253)}, }, "3": { "start": { "name": "Pont de Levallois", "coords": (2.280413812210845, 48.89715409503059), }, "end": {"name": "Gallieni", "coords": (2.41669727284764, 48.86533531722583)}, }, "3bis": { "start": {"name": "Gambetta", "coords": (2.398746593442591, 48.86516343394703)}, "end": { "name": "Porte des Lilas", "coords": (2.40672924554309, 48.87711051082896), }, }, "4": { "start": { "name": "Porte de Clignancourt", "coords": (2.344847748752398, 48.89740222196378), }, "end": { "name": "Mairie de Montrouge", "coords": (2.319740313298555, 48.818676408977936), }, }, "5": { "start": {"name": "Bobigny", "coords": (2.449189904479335, 48.906374770235026)}, "end": { "name": "Place d'Italie", "coords": (2.35558027407791, 48.830972672053754), }, }, "6": { "start": { "name": "Kléber", "coords": (2.293240649947313, 48.87126214352652), }, "end": {"name": "Picpus", "coords": (2.401289019827348, 48.84506157901035)}, }, "7": { "start": { "name": "La Courneuve", "coords": (2.410598616469425, 48.920785968128676), }, "end": {"name": "Villejuif", "coords": (2.368269540049694, 48.79648308361576)}, }, "7bis": { "start": { "name": "Louis Blanc", "coords": (2.364378741179748, 48.8811921181366), }, "end": { "name": "Pré Saint-Gervais", "coords": (2.398468172268172, 48.88027195609515), }, }, "8": { "start": {"name": "Balard", "coords": (2.278330259866023, 48.836295300607894)}, "end": { "name": "Pointe du Lac", "coords": (2.464280070543357, 48.76881073327119), }, }, "9": { "start": { "name": "Pont de Sèvres", "coords": (2.231028100202621, 48.829746119059685), }, "end": { "name": "Mairie de Montreuil", "coords": (2.441521809411031, 48.86229941188523), }, }, "10": { "start": {"name": "Boulogne", "coords": (2.228536981491631, 48.8407450151916)}, "end": { "name": "Gare d'Austerlitz", "coords": (2.375747983215603, 48.82999019896456), }, }, "11": { "start": {"name": "Châtelet", "coords": (2.348036565400401, 48.85763140976555)}, "end": { "name": "Mairie des Lilas", "coords": (2.416479643681515, 48.87976125216355), }, }, "12": { "start": { "name": "Front Populaire", "coords": (2.365920319400959, 48.90656714504601), }, "end": { "name": "Mairie d'Issy", "coords": (2.273665557499754, 48.82430937015939), }, }, "13": { "start": { "name": "Saint-Denis", "coords": (2.359366296360598, 48.93677678897849), }, "end": {"name": "Châtillon", "coords": (2.301678555482428, 48.81074648584623)}, }, "14": { "start": { "name": "Mairie de Saint-Ouen", "coords": (2.334663150119757, 48.9132020942236), }, "end": {"name": "Olympiades", "coords": (2.367173024477846, 48.8271636169609)}, }, } ratp-api-python-1.0.3/src/ratp_api/main.py000066400000000000000000000220231455106402200204310ustar00rootroot00000000000000import json import logging import uuid from enum import Enum import requests from affluence.line_mappings import line_end_points from ratp_api.models.line import LineData logging.basicConfig(level=logging.INFO) class LineID(Enum): RER_A = "LIG:IDFM:C01742" RER_B = "LIG:IDFM:C01743" RER_C = "LIG:IDFM:C01727" RER_D = "LIG:IDFM:C01728" RER_E = "LIG:IDFM:C01729" TRANSILIEN_H = "LIG:IDFM:C01737" TRANSILIEN_J = "LIG:IDFM:C01739" TRANSILIEN_K = "LIG:IDFM:C01738" TRANSILIEN_L = "LIG:IDFM:C01740" TRANSILIEN_N = "LIG:IDFM:C01736" TRANSILIEN_P = "LIG:IDFM:C01730" TRANSILIEN_R = "LIG:IDFM:C01731" TRANSILIEN_U = "LIG:IDFM:C01741" METRO_1 = "LIG:IDFM:C01371" METRO_2 = "LIG:IDFM:C01372" METRO_3 = "LIG:IDFM:C01373" METRO_3BIS = "LIG:IDFM:C01386" METRO_4 = "LIG:IDFM:C01374" METRO_5 = "LIG:IDFM:C01375" METRO_6 = "LIG:IDFM:C01376" METRO_7 = "LIG:IDFM:C01377" METRO_7BIS = "LIG:IDFM:C01387" METRO_8 = "LIG:IDFM:C01378" METRO_9 = "LIG:IDFM:C01379" METRO_10 = "LIG:IDFM:C01380" METRO_11 = "LIG:IDFM:C01381" METRO_12 = "LIG:IDFM:C01382" METRO_13 = "LIG:IDFM:C01383" METRO_14 = "LIG:IDFM:C01384" METRO_FUNICULAIRE = "LIG:IDFM:C01385" METRO_ORLYVAL = "LIG:IDFM:C01388" TRAM_T1 = "LIG:IDFM:C01389" TRAM_T2 = "LIG:IDFM:C01390" TRAM_T3A = "LIG:IDFM:C01391" TRAM_T3B = "LIG:IDFM:C01679" TRAM_T4 = "LIG:IDFM:C01843" TRAM_T5 = "LIG:IDFM:C01684" TRAM_T6 = "LIG:IDFM:C01794" TRAM_T7 = "LIG:IDFM:C01774" TRAM_T8 = "LIG:IDFM:C01795" TRAM_T9 = "LIG:IDFM:C02317" TRAM_T10 = "LIG:IDFM:C02528" TRAM_T11_EXPRESS = "LIG:IDFM:C01999" TRAM_T12 = "LIG:IDFM:C02529" TRAM_T13 = "LIG:IDFM:C02344" def __str__(self): return self.value class RatpAPI: """ A class to interact with the RATP API. """ GLOBAL_TRAFFIC_URL = "https://bff.bonjour-ratp.fr/lines/situations?" LINE_TRAFFIC_URL = "https://bff.bonjour-ratp.fr/lines/{}/situations?" AFFLUENCE_URL = "https://bff.bonjour-ratp.fr/itineraries/query?" def __init__(self, api_key: str = "e2rDkJzd2c1dPaFh7e0pJ9H7NjeqTQHg6ql31LmZ"): """ Initialize the RatpAPI class with the given API key. :param api_key: A string representing the API key for the RATP API. """ self.x_api_key = api_key self.x_client_guid = str(uuid.uuid4()) self.session = self.get_session() def get_session(self) -> requests.Session: """ Create and return a new session with pre-configured headers. :return: A requests.Session object for making API calls. """ session = requests.Session() headers = { "x-api-key": self.x_api_key, "x-client-guid": self.x_client_guid, "x-client-platform": "bonjour_ios", "x-client-version": "latest", "User-Agent": "RATP/10.35.1 (com.ratp.ratp; build:231; iOS 17.0.3)", } session.headers.update(headers) return session def make_request(self, method, url, **kwargs) -> dict: """ Make an HTTP request using the initialized session. :param method: HTTP method (e.g., 'GET', 'POST'). :param url: URL to which the request is sent. :param kwargs: Additional arguments to pass to the request method. :return: The JSON response from the API if the request is successful; an empty dictionary otherwise. """ try: response = self.session.request(method=method, url=url, **kwargs) response.raise_for_status() return response.json() except requests.RequestException as e: logging.info(f"Error: {e}") return {} def get_global_traffic(self) -> dict: """ Retrieve global traffic information. :return: A dictionary representing the global traffic situation. """ return self.make_request("GET", self.GLOBAL_TRAFFIC_URL) def get_line_traffic(self, line_id: LineID) -> LineData: """ Retrieve traffic information for a specific line. :param line_id: The ID of the line for which traffic information is requested. :return: A dictionary representing the traffic situation for the specified line. """ url = self.LINE_TRAFFIC_URL.format(line_id) line_data_raw = self.make_request("GET", url) line_data = LineData(**line_data_raw) return line_data def get_affluence(self, start, end, line_id): """ Retrieve affluence information for a specific journey on a given line. :param start: A tuple (longitude, latitude) representing the start location. :param end: A tuple (longitude, latitude) representing the end location. :param line_id: The ID of the line for which affluence information is requested. :return: A dictionary containing affluence information, or an empty dict if not available. """ line_id_adjusted = line_id.replace("bis", "B") payload = self._create_affluence_payload(start, end) response = self.make_request("POST", self.AFFLUENCE_URL, data=payload) return self._parse_affluence_response(response, line_id_adjusted) def _create_affluence_payload(self, start, end): """ Create the payload for the affluence request. :param start: The start coordinates (longitude, latitude). :param end: The end coordinates (longitude, latitude). :return: A JSON string for the payload. """ start_longitude, start_latitude = start end_longitude, end_latitude = end return json.dumps( { "destination": {"longitude": end_longitude, "latitude": end_latitude}, "transportModes": ["ALL"], "origin": {"longitude": start_longitude, "latitude": start_latitude}, "withReducedMobility": False, } ) def _parse_affluence_response(self, response, line_id) -> dict: """ Parse the response from the affluence request. :param response: The response received from the affluence request. :param line_id: The line ID used in the affluence request. :return: A dictionary containing parsed affluence information, or an empty dict if not available. """ for itinerary in response.get("itineraries", []): for segment in itinerary["segments"]: if ( segment["transportMode"] == "METRO" and segment["groupOfLines"]["name"] == line_id ): comfort = segment.get("comfort", {}) if "level" in comfort: comfort["lineId"] = segment["line"]["id"] return comfort return {} def get_all_lines_affluence(self): """ Retrieve affluence information for all lines. :return: A list of dictionaries containing affluence information for each line. """ affluences = [] for line_id, endpoints in line_end_points.items(): try: comfort = self.get_affluence( start=endpoints["start"]["coords"], end=endpoints["end"]["coords"], line_id=line_id, ) if "level" in comfort: comfort["lineDisplayCode"] = line_id affluences.append(comfort) else: logging.info(f"No affluence level found for {line_id}") except Exception as e: logging.info(f"Error fetching affluence for {line_id}: {e}") return affluences def get_line_affluence(self, line_id: LineID): """ Retrieve affluence information for a specific line. :param line_id: The ID of the line for which affluence information is requested. :return: A dictionary containing affluence information, or an empty dict if not available. """ line_id = str(line_id.name).split("_")[1] endpoints = line_end_points.get(line_id) if not endpoints: logging.info(f"No endpoints found for {line_id}") return {} try: comfort = self.get_affluence( start=endpoints["start"]["coords"], end=endpoints["end"]["coords"], line_id=line_id, ) if "level" in comfort: comfort["lineDisplayCode"] = line_id return comfort else: logging.info(f"No affluence level found for {line_id}") except Exception as e: logging.info(f"Error fetching affluence for {line_id}: {e}") return {} if __name__ == "__main__": api = RatpAPI(api_key="e2rDkJzd2c1dPaFh7e0pJ9H7NjeqTQHg6ql31LmZ") line_data = api.get_line_traffic(line_id=LineID.METRO_14) print(line_data) for situation in line_data.situations: print(situation) # print(api.get_line_affluence(line_id=LineID.METRO_9)) # print(api.get_all_lines_affluence()) ratp-api-python-1.0.3/src/ratp_api/models/000077500000000000000000000000001455106402200204175ustar00rootroot00000000000000ratp-api-python-1.0.3/src/ratp_api/models/__init__.py000066400000000000000000000000001455106402200225160ustar00rootroot00000000000000ratp-api-python-1.0.3/src/ratp_api/models/line.py000066400000000000000000000011571455106402200217240ustar00rootroot00000000000000from pydantic import BaseModel, HttpUrl class Icon(BaseModel): svg: HttpUrl png: HttpUrl name: str class Assets(BaseModel): icon: Icon class Line(BaseModel): id: str name: str displayCode: str businessMode: str assets: Assets class SituationMessage(BaseModel): isActive: bool isPlanned: bool criticity: str messages: list[str] class TwitterAccountInfos(BaseModel): twitterId: str twitterUrl: HttpUrl isThreadActive: bool class LineData(BaseModel): line: Line situations: list[SituationMessage] twitterAccountInfos: TwitterAccountInfos