Small module that makes your journey with RMV REST API somewhat easier.

Go to file

Renovate 08a4e6d0a4 Some checks failed Tests / test (3.10) (pull_request) Successful in 0s Details Tests / test (3.11) (pull_request) Successful in 1s Details Tests / test (3.12) (pull_request) Successful in 7s Details Tests / test (3.8) (pull_request) Failing after -49s Details Tests / test (3.9) (pull_request) Successful in 4s Details Update dependency tox to v4.21.1		2024-10-03 00:23:37 +03:00
.gitea/workflows	Added Python 3.12 to testing matrix	2024-09-08 01:58:25 +02:00
requirements	Update dependency tox to v4.21.1	2024-10-03 00:23:37 +03:00
src/pyrmv	Possibly fixed false positives on exception detection	2024-09-19 22:03:57 +02:00
tests	Changed testing method for Client.him_search()	2024-09-08 01:28:18 +02:00
wiki	Documentation prepared and improved	2023-11-25 13:16:48 +01:00
.gitignore	Dependencies bumped and .gitignore updated	2024-09-08 01:27:58 +02:00
.renovaterc	Add '.renovaterc'	2023-04-21 10:07:48 +03:00
LICENSE	Configured license and versions	2022-09-22 18:35:21 +02:00
pyproject.toml	Updated to 0.4.0	2024-09-08 01:44:18 +02:00
README.md	Fixed installation methods	2023-11-25 13:20:00 +01:00
tox.ini	Added Python 3.12 support	2024-09-07 20:21:52 +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)
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?
Some methods work slightly different

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