TransLink Open API, in Python.
Project description
Tilapya: TransLink API, in Python
Tilapya is a Python wrapper around the TransLink Open API, which provides real-time transit information for the Metro Vancouver region.
Tilapya has three 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 2018 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
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.
History
1.0.0 (2019-06-23)
Drop support for Python 2.7 and 3.4.
Remove RTDS API. It was removed upstream.
Switch GTFS-RT to v2 endpoints. v1 was removed upstream.
Add service alerts endpoint to GTFS-RT. It was added to v2 upstream.
0.2.0 (2019-02-03)
Require Marshmallow >= 3.0.0rc1, to fix dependency resolution problem.
Require Requests >= 2.20.0.
Replace API for GTFS-RT.
0.1.0 (2018-02-19)
Initial version.
