Profitroll
73a16c8b13
Tests / test (3.10) (push) Failing after 22m50s
Details
Tests / test (3.11) (push) Failing after 22m48s
Details
Tests / test (3.8) (push) Failing after 23m11s
Details
Tests / test (3.9) (push) Failing after 22m48s
Details
Reviewed-on: #25 |
||
|---|---|---|
| .gitea/workflows | ||
| requirements | ||
| src/pyrmv | ||
| tests | ||
| wiki | ||
| .gitignore | ||
| .renovaterc | ||
| LICENSE | ||
| README.md | ||
| pyproject.toml | ||
| tox.ini | ||
README.md
PythonRMV
Small module that makes your journey with RMV REST API somehow easier. Based fully on official RMV API reference and HAFAS documentation.
Requirements
- RMV API key (Get it here)
- Python 3.8+
- git (Only for installation from source)
Installation
If you have everything listed in requirements, then let's begin.
Variant 1
python -m pip install pyrmv
Variant 2
python -m pip install git+https://git.end-play.xyz/profitroll/PythonRMV.git
Usage
import pyrmv
# Define a Client with API key
client = pyrmv.Client("AcessId")
# Get origin's and destination's location
origin = client.stop_by_name("Frankfurt Hauptbahnhof", max_number=3)[0]
destination = client.stop_by_coords(50.099613, 8.685449, max_number=3)[0]
# Find a trip by locations you got above
trip = client.trip_find(origin_id=origin.id, dest_id=destination.id)
Frequently Asked Questions
Why are there raw versions and formatted ones?
For the purposes of my projects I don't really need all the stuff RMV gives (even though it's not much). I only need some specific things. However I do understand that in some cases other users may find those methods quite useful so I implemented them as well.
Some methods work slightly different
Can be. Not all function arguments written may work perfectly because I simply did not test each and every request. Some of arguments may be irrelevant in my use-case and the others are used quite rare at all. Just make an issue and I'll implement it correct when I'll have some free time.
To-Do
General
- Docs in Wiki
- Tickets