Skip to main content

API Wrapper for VVS (Verkehrsverbund Stuttgart)

Project description

VVS API Wrapper

Checkup status

Note: This is still work in progress


Fully object-oriented library to integrate the VVS API into your project.

Installation

pip install vvspy

Requirements

Python 3.6 or higher

Examples

  • Detect delay in upcoming departures:
from vvspy import get_departures

deps = get_departures("5006115", limit=3)  # Stuttgart main station
for dep in deps:
    if dep.delay > 0:
        print("Alarm! Delay detected.")
        print(dep)  # Station @ Timestamp: Train: Origin - Destination
  • Get complete trip info between two stations:
from vvspy import get_trip

# TODO
  • Filter for specific lines:
from vvspy import get_departures

deps = get_departures("5006118")  # Stuttgart main station (lower)
for dep in deps:
    if dep.serving_line.symbol == "S4":
        print(f"Departure of S4 at {dep.real_datetime}")

Features

  • fully object oriented results
  • full customizable requests and parameters # coming soon
  • parsing all available info into result obj
  • Well tested and maintained
  • Departures, Arrivals, Trips, Station info, Upcoming events, Maintenance work

See issues/projects on GitHub for upcoming features

Contributors

License:

This project is licensed under MIT.

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

vvspy-0.1.1.tar.gz (60.4 kB view hashes)

Uploaded Source

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