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.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

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.4.0rc1.tar.gz (39.0 kB view details)

Uploaded Source

Built Distribution

pyrmv-0.4.0rc1-py3-none-any.whl (54.3 kB view details)

Uploaded Python 3

File details

Details for the file pyrmv-0.4.0rc1.tar.gz.

File metadata

  • Download URL: pyrmv-0.4.0rc1.tar.gz
  • Upload date:
  • Size: 39.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.13

File hashes

Hashes for pyrmv-0.4.0rc1.tar.gz
Algorithm Hash digest
SHA256 17ba6d26c3fffeeb5c7ef04ab30dc87536c3c1caf3ca0ecb144a971794abfc10
MD5 d96f8c4fa34ace1382755e825a111d7d
BLAKE2b-256 630bcd5ea50a1726a2ff32b2e2fc235ac77006ed9eb69a1fdd8220bd9b4ae846

See more details on using hashes here.

File details

Details for the file pyrmv-0.4.0rc1-py3-none-any.whl.

File metadata

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

File hashes

Hashes for pyrmv-0.4.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 3651bf6e21ecac9863bac1698e634856c88ee33551b1d6f0a0a9a20c8d0ae349
MD5 decc8807ad08ad8a32038c0789436cd9
BLAKE2b-256 1781025a69e5c70babb8deb263924d7adb792a67608bae8796d1a9c40fd98b34

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