singstat
========
|pyversions| |pypi| |status| |license| |readthedocs|
.. |pyversions| image:: https://img.shields.io/pypi/pyversions/singstat
:alt: Python 3
.. |pypi| image:: https://img.shields.io/pypi/v/singstat
:alt: PyPi
:target: https://pypi.org/project/singstat
.. |status| image:: https://img.shields.io/pypi/status/singstat
:alt: PyPi status
.. |license| image:: https://img.shields.io/github/license/yuhui/singstat
:alt: GNU General Public License v3.0
:target: https://www.gnu.org/licenses/gpl-3.0.html
.. |readthedocs| image:: https://readthedocs.org/projects/singstat/badge/?version=latest
:alt: Documentation Status
:target: https://singstat.readthedocs.io/en/latest/?badge=latest
This is an unofficial Python package for interacting with APIs available at
`SingStat.gov.sg`_.
.. _SingStat.gov.sg: https://www.singstat.gov.sg
Installing the package
----------------------
Install the package using ``pip``::
pip install singstat
Using the package
-----------------
The main steps are:
1. Import the Client class.
2. Instantiate an object from the Client class.
3. Call a function on that object.
For more information, `refer to the documentation`_.
.. _refer to the documentation: http://singstat.readthedocs.io/
Usage overview
^^^^^^^^^^^^^^
Interacting with `SingStat.gov.sg`_'s API is done through a client.
This 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.
Reference
---------
`SingStat.gov.sg's Developer Guide`_
.. _SingStat.gov.sg's Developer Guide: https://tablebuilder.singstat.gov.sg/view-api/for-developers
Raw data
{
"_id": null,
"home_page": "https://github.com/yuhui/singstat",
"name": "singstat",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3,<4",
"maintainer_email": "",
"keywords": "singstat,singapore statistics,department of statistics singapore,python,singapore,wrapper",
"author": "Yuhui",
"author_email": "yuhuibc@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/7a/ae/9a291d3e198bf8d4973ebd64ab84f9b0a33ca8b0006874c659e479426171/singstat-1.1.0.tar.gz",
"platform": "MacOS X",
"description": "singstat\n========\n\n|pyversions| |pypi| |status| |license| |readthedocs|\n\n.. |pyversions| image:: https://img.shields.io/pypi/pyversions/singstat\n :alt: Python 3\n.. |pypi| image:: https://img.shields.io/pypi/v/singstat\n :alt: PyPi\n :target: https://pypi.org/project/singstat\n.. |status| image:: https://img.shields.io/pypi/status/singstat\n :alt: PyPi status\n.. |license| image:: https://img.shields.io/github/license/yuhui/singstat\n :alt: GNU General Public License v3.0\n :target: https://www.gnu.org/licenses/gpl-3.0.html\n.. |readthedocs| image:: https://readthedocs.org/projects/singstat/badge/?version=latest\n :alt: Documentation Status\n :target: https://singstat.readthedocs.io/en/latest/?badge=latest\n\nThis is an unofficial Python package for interacting with APIs available at\n`SingStat.gov.sg`_.\n\n.. _SingStat.gov.sg: https://www.singstat.gov.sg\n\nInstalling the package\n----------------------\n\nInstall the package using ``pip``::\n\n pip install singstat\n\nUsing the package\n-----------------\n\nThe main steps are:\n\n1. Import the Client class.\n2. Instantiate an object from the Client class.\n3. Call a function on that object.\n\nFor more information, `refer to the documentation`_.\n\n.. _refer to the documentation: http://singstat.readthedocs.io/\n\nUsage overview\n^^^^^^^^^^^^^^\n\nInteracting with `SingStat.gov.sg`_'s API is done through a client.\n\nThis client contains several public functions, one function per endpoint. A\nfunction's name is the same as its corresponding endpoint's ending path.\n\nMost functions accept named arguments, where an argument corresponds with a\nparameter that the endpoint accepts.\n\nReference\n---------\n\n`SingStat.gov.sg's Developer Guide`_\n\n.. _SingStat.gov.sg's Developer Guide: https://tablebuilder.singstat.gov.sg/view-api/for-developers\n",
"bugtrack_url": null,
"license": "GNU General Public License v3",
"summary": "Python package for interacting with APIs available at SingStat.gov.sg",
"version": "1.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/yuhui/singstat/issues",
"Homepage": "https://github.com/yuhui/singstat",
"Source": "https://github.com/yuhui/singstat"
},
"split_keywords": [
"singstat",
"singapore statistics",
"department of statistics singapore",
"python",
"singapore",
"wrapper"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "29cff221a6ec16f474972d37c7b39738cd85c0943316bfbf4d8a960b59b761ee",
"md5": "a93fee7a98c5aa2c3b60514fc5c9c457",
"sha256": "d08611ad7528b883850173e7bc59b5d04bb33608d00fad018fe70c7eef2caffe"
},
"downloads": -1,
"filename": "singstat-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a93fee7a98c5aa2c3b60514fc5c9c457",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3,<4",
"size": 20700,
"upload_time": "2024-02-02T15:51:13",
"upload_time_iso_8601": "2024-02-02T15:51:13.947295Z",
"url": "https://files.pythonhosted.org/packages/29/cf/f221a6ec16f474972d37c7b39738cd85c0943316bfbf4d8a960b59b761ee/singstat-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7aae9a291d3e198bf8d4973ebd64ab84f9b0a33ca8b0006874c659e479426171",
"md5": "8cfe8e9954e46e518e79968458187d78",
"sha256": "3a47bfbe287bdef94196f00bddb3b9ac637940cacb28e1cfdb4341abff87d69e"
},
"downloads": -1,
"filename": "singstat-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "8cfe8e9954e46e518e79968458187d78",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3,<4",
"size": 20373,
"upload_time": "2024-02-02T15:51:15",
"upload_time_iso_8601": "2024-02-02T15:51:15.274999Z",
"url": "https://files.pythonhosted.org/packages/7a/ae/9a291d3e198bf8d4973ebd64ab84f9b0a33ca8b0006874c659e479426171/singstat-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-02 15:51:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yuhui",
"github_project": "singstat",
"travis_ci": false,
"coveralls": true,
"github_actions": false,
"requirements": [],
"lcname": "singstat"
}
JSON
