PythonRMV/src/pyrmv/__init__.py

30 lines
744 B
Python
Raw Normal View History

2022-09-22 16:13:02 +03:00
"""
## PythonRMV
2022-09-22 19:35:21 +03:00
Small module that makes your journey with RMV REST API somehow easier. Based fully on official RMV API reference and HAFAS documentation.
2022-09-22 16:13:02 +03:00
## Usage
2022-09-22 16:13:02 +03:00
```py
import pyrmv
2022-09-22 16:13:02 +03:00
2022-10-07 14:47:25 +03:00
# Define a Client with API key
client = pyrmv.Client("AcessId")
2022-09-22 16:13:02 +03:00
# Get origin's and destination's location
2022-10-07 14:47:25 +03:00
origin = client.stop_by_name("Frankfurt Hauptbahnhof", max_number=3)[0]
destination = client.stop_by_coords(50.099613, 8.685449, max_number=3)[0]
2022-09-22 16:13:02 +03:00
# Find a trip by locations got
2022-10-07 14:47:25 +03:00
trip = client.trip_find(origin_id=origin.id, dest_id=destination.id)
```
2022-09-22 16:13:02 +03:00
"""
2022-09-22 19:35:21 +03:00
__name__ = "pyrmv"
2023-11-25 15:21:48 +02:00
__version__ = "0.4.0-rc.1"
2022-09-22 19:35:21 +03:00
__license__ = "MIT License"
2022-09-22 16:13:02 +03:00
__author__ = "Profitroll"
2023-11-24 13:35:51 +02:00
from . import classes, const, enums, errors, raw, utility
2023-11-24 13:39:25 +02:00
from .classes.client import Client