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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyrmv-0.4.0.tar.gz
  • Upload date:
  • Size: 40.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for pyrmv-0.4.0.tar.gz
Algorithm Hash digest
SHA256 8bbc52d5a805ea3b85ec50cc6adc7154ee2cdce71356aae66b27e5396e2a2260
MD5 1354582503c03e3d04a7b78f3015d881
BLAKE2b-256 29ee02753ecd15359fa0e5a9f414550f351b0bd50b8b770783225b2ccafda029

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pyrmv-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 90a0b74dcb486668c5acfec17fc90bb23f8614041ca69fb77130f155febbd9eb
MD5 583303b954d7ef003a14670811dc3fdd
BLAKE2b-256 81650006fa28b345315c7aaaf689a23697cc9082b8ba94f4c59d78015c3286e6

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