Skip to main content

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

Project description

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.10+
  • 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("AccessId")

# 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 the 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyrmv-0.6.0.tar.gz (40.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyrmv-0.6.0-py3-none-any.whl (56.7 kB view details)

Uploaded Python 3

File details

Details for the file pyrmv-0.6.0.tar.gz.

File metadata

  • Download URL: pyrmv-0.6.0.tar.gz
  • Upload date:
  • Size: 40.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pyrmv-0.6.0.tar.gz
Algorithm Hash digest
SHA256 33a6fc38aa300f255fba623d57cf6ef3b89239b2497f7a94d2bb56c2ade10448
MD5 f0c5c8b4ed63d6d49f609f847783f433
BLAKE2b-256 debd60cb3f5968154aa144161a2187a13f5af05d2f95139ef66df2eddc92e1ae

See more details on using hashes here.

File details

Details for the file pyrmv-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: pyrmv-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 56.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pyrmv-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 938a8b88f974053586eee5fb154b780454fb0101b3c7b6ed4723e30814ec745f
MD5 26b3855421da8f33b5eae6b1bcfded9b
BLAKE2b-256 9c021a004a9c5ed71e21b5acf892ca86b1828c2086594669ebdea4e31a6d4b3a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page