Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

carsonyl/tilapya

Repository files navigation

Tilapya: TransLink API, in Python

https://img.shields.io/pypi/v/tilapya.svg?maxAge=2592000 https://readthedocs.org/projects/tilapya/badge/?version=latest

Tilapya is a Python wrapper around the TransLink Open API, which provides real-time transit information for the Metro Vancouver region.

Tilapya has interfaces which correspond directly to components of the TransLink Open API:

  • RTTI: Real-Time Transit Information
  • GTFSRT: GTFS-realtime feeds

Tilapya is more than a thin wrapper around the underlying REST APIs. Where possible, it smooths over some inconvenient return values, and guarantees a consistent schema in returned errors and responses.

Installation

Install Tilapya using pip:

$ pip install tilapya

The source is also available on GitHub.

Getting started

Use of the TransLink Open API, and thus Tilapya, requires an API key. If you don't already have an API key, you can get one by registering for an account at https://developer.translink.ca/Account/Register.

Tilapya's documentation is at https://tilapya.readthedocs.io. Tilapya's API docs contain examples for common operations.

License

Copyright 2019 Carson Lam

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.