landtransportsg

landtransportsg

|pyversions| |pypi| |status| |license| |readthedocs|

.. |pyversions| image:: https://img.shields.io/pypi/pyversions/landtransportsg :alt: Python 3 .. |pypi| image:: https://img.shields.io/pypi/v/landtransportsg :alt: PyPi :target: https://pypi.org/project/landtransportsg .. |status| image:: https://img.shields.io/pypi/status/landtransportsg :alt: PyPi status .. |license| image:: https://img.shields.io/github/license/yuhui/landtransportsg :alt: GNU General Public License v3.0 :target: https://www.gnu.org/licenses/gpl-3.0.html .. |readthedocs| image:: https://readthedocs.org/projects/landtransportsg/badge/?version=latest :alt: Documentation Status :target: https://landtransportsg.readthedocs.io/en/latest/?badge=latest

This is an unofficial Python package for interacting with APIs available at LTA DataMall_.

.. _LTA DataMall: https://www.mytransport.sg/content/mytransport/home/dataMall.html

Installing the package

Install the package using pip::

pip install landtransportsg

Using the package

Pre-requisite:

• API key from LTA. Request for API access_.

.. _Request for API access: https://www.mytransport.sg/content/mytransport/home/dataMall/request-for-api.html

The main steps are:

1. Import a class.
2. Instantiate an object from the class.
3. Call a function on that object.

For more information, refer to the documentation_.

.. _refer to the documentation: http://landtransportsg.readthedocs.io/

Usage overview ^^^^^^^^^^^^^^

Interacting with LTA DataMall_'s API is done through one of three clients, where each client corresponds with a set of endpoints.

The four clients are: ActiveMobility, Geospatial, PublicTransport and Traffic.

Each client contains several public functions, one function per endpoint. A function's name is the same as its corresponding endpoint's ending path.

Some functions accept named arguments, where an argument corresponds with a parameter that the endpoint accepts.

*Why have separate clients instead of one single client?*

Without knowing how `LTA DataMall`_'s API will evolve, and noticing that
the endpoints were themselves already partitioned into sets, it seemed like
a good idea to keep each set of endpoints in its own contextual client. This
allows for each set of endpoints to be customised on their own, e.g. the
``PublicTransport`` passenger volume-related endpoints allow for a string
to be returned, whereas the other endpoints return a list.

Reference

LTA DataMall's Developer Guide_

.. _LTA DataMall's Developer Guide: https://www.mytransport.sg/content/mytransport/home/dataMall/dynamic-data.html