Metadata-Version: 2.1
Name: datagovsg
Version: 1.0.1
Summary: Python package for interacting with APIs available at Data.gov.sg
Home-page: https://github.com/yuhui/datagovsg
Author: Yuhui
Author-email: yuhuibc@gmail.com
License: GNU General Public License v3
Project-URL: Source, https://github.com/yuhui/datagovsg
Project-URL: Bug Tracker, https://github.com/yuhui/datagovsg/issues
Description: datagovsg
        =========
        
        |pyversions| |pypi| |status| |license| |readthedocs|
        
        .. |pyversions| image:: https://img.shields.io/pypi/pyversions/datagovsg
           :alt: Python 3
        .. |pypi| image:: https://img.shields.io/pypi/v/datagovsg
           :alt: PyPi
           :target: https://pypi.org/project/datagovsg
        .. |status| image:: https://img.shields.io/pypi/status/datagovsg
           :alt: PyPi status
        .. |license| image:: https://img.shields.io/github/license/yuhui/datagovsg
           :alt: GNU General Public License v3.0
           :target: https://www.gnu.org/licenses/gpl-3.0.html
        .. |readthedocs| image:: https://readthedocs.org/projects/datagovsg/badge/?version=latest
           :alt: Documentation Status
           :target: https://datagovsg.readthedocs.io/en/latest/?badge=latest
        
        This is an unofficial Python package for interacting with APIs available at `Data.gov.sg`_.
        
        .. _Data.gov.sg: https://data.gov.sg
        
        Installing the package
        ----------------------
        
        Install the package using ``pip``::
        
            pip install datagovsg
        
        Using the package
        -----------------
        
        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://datagovsg.readthedocs.io/
        
        Usage overview
        ^^^^^^^^^^^^^^
        
        Interacting with `Data.gov.sg`_'s API is done through one of four clients, where each client corresponds with a "set" of endpoints. (`Data.gov.sg`_ doesn't categorise its endpoints by set, but it can be assumed from the endpoints' path directories.)
        
        The four clients are: ``Ckan``, ``Environment``, ``Technology`` and ``Transport``.
        
        Each client contains several public functions, one function per endpoint. A function's name is the same as its corresponding endpoint's ending path.
        
        Most 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 `Data.gov.sg`_'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 ``Environment`` endpoints allow for either a date or date-time to be specified, whereas the ``Transport`` endpoints don't.
        
        Reference
        ---------
        
        `Data.gov.sg's Developer Guide`_
        
        .. _Data.gov.sg's Developer Guide : https://data.gov.sg/developer
        
Keywords: data.gov.sg,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
