2022-09-21 13:06:04 +03:00
|
|
|
# PythonRMV
|
|
|
|
|
|
2022-09-22 16:13:41 +03:00
|
|
|
Small module that makes your journey with RMV REST API somehow easier.
|
|
|
|
|
|
|
|
|
|
# Get started
|
|
|
|
|
|
|
|
|
|
As you can guess you need to have RMV API key. You can get it for free on the [RMV website](https://opendata.rmv.de/site/start.html).
|
|
|
|
|
After that you also need to have Python3. I've tested all of that on Python 3.7.9 and Python 3.9.13.
|
|
|
|
|
Other versions should work too but I simply did not test it. Second python is not supported because why should it be.
|
|
|
|
|
Don't forget to install git. Of course you can download the repo without it but it's simply faster to use git.
|
|
|
|
|
|
|
|
|
|
# Installation
|
|
|
|
|
|
|
|
|
|
If you have all the listed in [Get started](#get-started), then let's begin.
|
|
|
|
|
|
|
|
|
|
1. `git clone https://git.end-play.xyz/profitroll/PythonRMV.git`
|
|
|
|
|
2. `cd PythonRMV`
|
|
|
|
|
3. `python -m pip install -r requirements.txt`
|
|
|
|
|
|
|
|
|
|
Done. You can now use everything that lays in PythonRMV.
|
|
|
|
|
|
|
|
|
|
# Frequently Asked Questions
|
|
|
|
|
|
|
|
|
|
- [Why are there raw versions and formatted ones?](#why-are-there-raw-versions-and-formatted-ones)
|
|
|
|
|
- [Some methods work slightly different](#some-methods-work-slightly-different)
|
|
|
|
|
- [Documentation is not perfectly clear](#documentation-is-not-perfectly-clear)
|
|
|
|
|
|
|
|
|
|
## 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 and the rest I don't even need. However I do understand that in some
|
|
|
|
|
cases other users may find those methods quite useful so I implemented them too.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Some methods work slightly different
|
|
|
|
|
|
|
|
|
|
Can be. Not all the arguments written may work perfectly because I simply did not test them all.
|
|
|
|
|
Some of them may be irrelevant in my use-case and the others are used quite rare at all.
|
|
|
|
|
Just [make an issue](https://git.end-play.xyz/profitroll/PythonRMV/issues/new) and I'll implement it correct when I'll have some free time.
|
|
|
|
|
|
|
|
|
|
## Documentation is not perfectly clear
|
|
|
|
|
|
|
|
|
|
Of course docs cannot be perfect in the format of python docstring, especially if I also don't always
|
|
|
|
|
know how things should correctly work so that's why you get HAFAS API docs together with your
|
|
|
|
|
RMV API key. Just use my functions in connection with those docs, if you want to build something
|
|
|
|
|
actually sophisticated. But remember, that I wrote all of that without sophistication in mind.
|
|
|
|
|
|
|
|
|
|
# To-Do
|
|
|
|
|
[ ] arrivalBoard (boardArrival)
|
|
|
|
|
[ ] departureBoard (boardArrival)
|
|
|
|
|
[*] himsearch (himSearch)
|
|
|
|
|
[ ] journeyDetail
|
|
|
|
|
[*] location.nearbystops (stopByCoords)
|
|
|
|
|
[*] location.name (stopByName)
|
|
|
|
|
[ ] recon
|
|
|
|
|
[*] trip (findRoute)
|
