40 lines
1.7 KiB
Python
40 lines
1.7 KiB
Python
"""
|
|
## PythonRMV
|
|
|
|
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).
|
|
|
|
## 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.
|
|
"""
|
|
|
|
__version__ = "0.1"
|
|
__author__ = "Profitroll"
|
|
|
|
from . import raw |