Skip to main content

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

Project description

PythonRMV

Small module that makes your journey with RMV REST API somehow easier. Based fully on official RMV API reference and HAFAS documentation.

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, destination_id=destination.id)

Frequently Asked Questions

  • Why are there raw versions and formatted ones?
  • Some methods work slightly different
  • Documentation is not perfectly clear

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)

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.2.1.tar.gz (21.4 kB view details)

Uploaded Source

Built Distribution

pyrmv-0.2.1-py3-none-any.whl (30.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyrmv-0.2.1.tar.gz
  • Upload date:
  • Size: 21.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for pyrmv-0.2.1.tar.gz
Algorithm Hash digest
SHA256 f672a0987f26e48df12278829e631b1d800c64afb2e9b2aca5561c3e4221c46b
MD5 0d72d7c900e6493a18c91b3cc962a39a
BLAKE2b-256 3d5f711408ac9d15a3ae1447e8ea61a27a16deab18eda771e8324f8e3dd023e0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyrmv-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 30.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for pyrmv-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 35c5886bbf964fc707ffe229981a531eda802680a9d9f930bffdc3e6f1c7034e
MD5 b8a946c5ef77c131f131f487fc12b7cd
BLAKE2b-256 cf1e1b346354e0fd17637c8b8d4ab5cdf95dfd10f98c753a5b56ed6f95ea2aaf

See more details on using hashes here.

Supported by

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