Small module that makes your journey with RMV REST API somewhat easier.
Go to file
profitroll 9d49b1b0c8
Some checks failed
Tests / test (3.10) (push) Failing after 22m50s
Tests / test (3.11) (push) Failing after 22m51s
Tests / test (3.9) (push) Has been cancelled
Tests / test (3.8) (push) Has been cancelled
Fixed wrong license attribute
2024-05-19 14:18:41 +02:00
.gitea/workflows Drop support for Python 3.7 (due to EOL) 2023-11-19 23:47:41 +01:00
requirements Merge pull request 'Update dependency twine to ~=5.1.0' (#30) from renovate/twine-5.x into dev 2024-05-19 12:07:29 +03:00
src/pyrmv Upgrade to version to 0.4.0-rc.2 2023-11-27 21:57:48 +01:00
tests New date and time behavior, improved typing 2023-11-27 21:44:17 +01:00
wiki Documentation prepared and improved 2023-11-25 13:16:48 +01:00
.gitignore Structural changes 2023-11-19 22:38:51 +01: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 Fixed wrong license attribute 2024-05-19 14:18:41 +02:00
README.md Fixed installation methods 2023-11-25 13:20:00 +01:00
tox.ini Added pyrmv[speed] with ujson as a speedup 2023-11-27 21:56:57 +01:00

PythonRMV

License: MIT Code style: black

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?

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