profitroll/PythonRMV
profitroll/PythonRMV
1
1
Fork 0
Code Issues Pull Requests Actions Packages Releases 3 Wiki Activity
Small module that makes your journey with RMV REST API somewhat easier.
44 Commits 2 Branches 3 Tags 1,010 KiB
Python 100%
7b0f2c31ed
Go to file
Profitroll 7b0f2c31ed Fixed rtDuration and transferCount
2022-09-24 13:07:58 +02:00
pyrmv Fixed rtDuration and transferCount 2022-09-24 13:07:58 +02:00
.gitignore Now ignoring .vscode 2022-09-23 13:54:48 +02:00
LICENSE Configured license and versions 2022-09-22 18:35:21 +02:00
README.md Updated README and version to 0.2.1 2022-09-24 13:02:49 +02:00
requirements.txt Added "isodate" to requirements 2022-09-23 22:58:21 +02:00
setup.cfg Tree changed once more 2022-09-22 19:27:34 +02:00
setup.py Updated README and version to 0.2.1 2022-09-24 13:02:49 +02:00

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)
  • Python3 (Tested versions are 3.7.9 and 3.9.13)
  • git (Only for installation from source)

Installation

If you have everything listed in requirements, then let's begin.

Variant 1:

  1. python -m pip install pyrmv

Variant 2:

  1. git clone https://git.end-play.xyz/profitroll/PythonRMV.git
  2. cd PythonRMV
  3. python setup.py install

Usage

import pyrmv

# Set API key
accessId = "Something"

# Get origin's and destination's location
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]

# Find a trip by locations got
trip = pyrmv.trip_find(accessId, 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.

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.

To-Do

  • arrivalBoard (board_arrival)
  • departureBoard (board_departure)
  • himsearch (him_search)
  • journeyDetail (journey_detail)
  • location.nearbystops (stop_by_coords)
  • location.name (stop_by_name)
  • trip (trip_find)
  • recon (trip_recon)