Metadata-Version: 2.1
Name: landtransportsg
Version: 1.3.0
Summary: Python package for interacting with APIs available at LTA DataMall
Home-page: https://github.com/yuhui/landtransportsg
Author: Yuhui
Author-email: yuhuibc@gmail.com
License: GNU General Public License v3
Project-URL: Source, https://github.com/yuhui/landtransportsg
Project-URL: Bug Tracker, https://github.com/yuhui/landtransportsg/issues
Keywords: lta,land transport authority,datamall,python,singapore,wrapper
Platform: MacOS X
Platform: POSIX
Platform: Windows
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Internet
Requires-Python: >=3
Description-Content-Type: text/x-rst
Requires-Dist: backoff (<2.0,>=1.8)
Requires-Dist: cachetools (<4.0,>=3)
Requires-Dist: pytz (<2020,>=2019)
Requires-Dist: requests (<3.0,>=2)

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


