PythonRMV/pyrmv/__init__.py

32 lines
749 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-09-23 23:58:05 +03:00
# Set API key
accessId = "Something"
2022-09-22 16:13:02 +03:00
# Get origin's and destination's location
2022-09-24 14:02:49 +03:00
origin = pyrmv.raw.stop_by_name(accessid, "Frankfurt Hauptbahnhof", maxNo=3)[0]
destination = pyrmv.raw.stop_by_coords(accessid, 50.099613, 8.685449, maxNo=3)[0]
2022-09-22 16:13:02 +03:00
# Find a trip by locations got
2022-09-24 14:02:49 +03:00
trip = pyrmv.trip_find(accessId, 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"
2022-09-24 14:02:49 +03:00
__version__ = "0.2.1"
2022-09-22 19:35:21 +03:00
__license__ = "MIT License"
2022-09-22 16:13:02 +03:00
__author__ = "Profitroll"
2022-09-23 12:18:18 +03:00
from . import raw
2022-09-23 14:53:33 +03:00
from . import errors
from . import utility
2022-09-23 23:59:48 +03:00
from . import classes
2022-09-23 14:53:33 +03:00
from .methods import *