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
access_id = "Something"

# Get origin's and destination's location
origin = pyrmv.raw.stop_by_name(access_id, "Frankfurt Hauptbahnhof", max_number=3)[0]
destination = pyrmv.stop_by_coords(access_id, 50.099613, 8.685449, max_number=3)[0]

## Find a trip by locations got
trip = pyrmv.trip_find(access_id, 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.2.tar.gz (22.5 kB view details)

Uploaded Source

Built Distribution

pyrmv-0.2.2-py3-none-any.whl (33.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyrmv-0.2.2.tar.gz
  • Upload date:
  • Size: 22.5 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.2.tar.gz
Algorithm Hash digest
SHA256 5cbb9e6ba778ed35d5a82dcaa34b5b7bc4a2227ece88a8caa823a73d878efbf2
MD5 56396722a3f2f80fdab3a4527a16a088
BLAKE2b-256 314e90d39451f9fbdf39dd07fbd57ff3a0bc956714de2721d50c4ae73cf998ee

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyrmv-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 33.0 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9dc962d02ce06c1925c50f92fe6952595ecf1551e08688179888f8af5dc753ec
MD5 b7c2f772665c19537be3884c528e0d0e
BLAKE2b-256 ec37a1597b78a383e707cc9b7fc3ba74dbeb9e00cbde98323224a765d16370c5

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