Metadata-Version: 2.1
Name: tilapya
Version: 0.2.0
Summary: TransLink Open API, in Python.
Home-page: https://github.com/carsonyl/tilapya
Author: Carson Lam
Author-email: carson.lam@alumni.ubc.ca
License: Apache Software License 2.0
Keywords: tilapya vancouver transit translink
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Internet :: WWW/HTTP
Requires-Python: >=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*
Requires-Dist: requests (<3.0.0,>=2.20.0)
Requires-Dist: marshmallow (<4.0.0,>=3.0.0rc1)
Requires-Dist: pytz

Tilapya: TransLink API, in Python
=================================

.. image:: https://img.shields.io/pypi/v/tilapya.svg?maxAge=2592000
    :target: https://pypi.org/project/tilapya
.. image:: https://img.shields.io/pypi/l/tilapya.svg
    :target: https://pypi.python.org/pypi/tilapya
.. image:: https://img.shields.io/pypi/pyversions/tilapya.svg
    :target: https://pypi.python.org/pypi/tilapya
.. image:: https://img.shields.io/travis/carsonyl/tilapya.svg?maxAge=2592000
    :target: https://travis-ci.org/carsonyl/tilapya
.. image:: https://readthedocs.org/projects/tilapya/badge/?version=latest
    :target: https://tilapya.readthedocs.io/en/latest/?badge=latest

**Tilapya** is a Python wrapper around the `TransLink Open API <https://developer.translink.ca/>`_,
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
* **RTDS**: Regional Traffic Data System
* **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 <https://pip.pypa.io>`_::

    $ pip install tilapya

The source is also `available on GitHub <https://github.com/carsonyl/tilapya>`_.



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

    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.


History
=======

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.


