Updated version to 0.1.9 and changed README
This commit is contained in:
@@ -3,38 +3,29 @@
|
||||
|
||||
Small module that makes your journey with RMV REST API somehow easier. Based fully on official RMV API reference and HAFAS documentation.
|
||||
|
||||
## Frequently Asked Questions
|
||||
## Usage
|
||||
|
||||
- [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)
|
||||
```py
|
||||
import pyrmv
|
||||
|
||||
### Why are there raw versions and formatted ones?
|
||||
accessId = "Something" # Set API key
|
||||
|
||||
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.
|
||||
# Get origin's and destination's location
|
||||
origin = pyrmv.raw.stop_by_name(accessid, "Frankfurt Hauptbahnhof", maxNo=3)[0]["StopLocation"]
|
||||
destination = pyrmv.raw.stop_by_coords(accessid, 50.099613, 8.685449, maxNo=3)[0]["StopLocation"]
|
||||
|
||||
|
||||
### 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](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 as a python docstring, especially if sometimes I don't
|
||||
know how things should correctly work. That's why you get HAFAS API docs in addition to your
|
||||
RMV API key. Just use my functions together with those docs, if you want to build something
|
||||
really sophisticated. However I'm not sure whether RMV supports that many HAFAS features publicly.
|
||||
# Find a trip by locations got
|
||||
trip = pyrmv.raw.trip_find(accessId, originId=origin["id"], destExtId=destination["id"])
|
||||
```
|
||||
"""
|
||||
|
||||
__name__ = "pyrmv"
|
||||
__version__ = "0.1.8"
|
||||
__version__ = "0.1.9"
|
||||
__license__ = "MIT License"
|
||||
__author__ = "Profitroll"
|
||||
|
||||
from . import raw
|
||||
from . import errors
|
||||
from . import utility
|
||||
from . import methods
|
||||
from .methods import *
|
Reference in New Issue
Block a user