# PyBMKG
[![CI](https://github.com/kiraware/PyBMKG/workflows/ci/badge.svg)](https://github.com/kiraware/PyBMKG/actions/workflows/ci.yml)
[![CodeQL](https://github.com/kiraware/PyBMKG/workflows/codeql/badge.svg)](https://github.com/kiraware/PyBMKG/actions/workflows/codeql.yml)
[![Docs](https://readthedocs.org/projects/pybmkg/badge/?version=latest)](https://pybmkg.readthedocs.io/en/latest/?badge=latest)
[![codecov](https://codecov.io/gh/kiraware/PyBMKG/graph/badge.svg?token=MN6AXAHO0P)](https://codecov.io/gh/kiraware/PyBMKG)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)
[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![pypi](https://img.shields.io/pypi/v/PyBMKG.svg)](https://pypi.org/project/PyBMKG/)
[![python](https://img.shields.io/pypi/pyversions/PyBMKG.svg)](https://pypi.org/project/PyBMKG/)
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/license/mit/)
This is documentation for the `PyBMKG` project that
is an asynchronous api wrapper written in Python for
[open data](https://data.bmkg.go.id/) on weather
forecasts and latest earthquakes in Indonesia served
by Meteorology, Climatology and Geophysics Agency
([BMKG](https://bmkg.go.id/)).
PyBMKG was created as a wrapper to handle API requests
BMKG open data asynchronously. This is because the
available API does not follow API standards in general,
therefore a wrapper was created which is expected to
make it easier to use the BMKG open data API with Python.
We use the third party library [aiohttp](https://docs.aiohttp.org/en/stable/)
for asynchronous client requests and it has been tested
to work well using the [asyncio](https://docs.python.org/3/library/asyncio.html)
library. Also it use [dataclass](https://docs.python.org/3/library/dataclasses.html)
as the schema.
## Docs
You can start reading the documentation [here](https://pybmkg.readthedocs.io/en/latest/).
## Contributing
Glad to hear you want to contribute to PyBMKG. Please see
[contributing guidelines](https://pybmkg.readthedocs.io/en/latest/how-to-guides/#contributing).
## Acknowledgements
We would like to thank the Meteorology, Climatology
and Geophysics Agency (BMKG) for its [open data service](https://data.bmkg.go.id/)
on weather forecasts and latest earthquake information.
Raw data
{
"_id": null,
"home_page": "https://github.com/kiraware/PyBMKG",
"name": "PyBMKG",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11,<4.0",
"maintainer_email": "",
"keywords": "bmkg,api",
"author": "Kira",
"author_email": "kiraware@github.com",
"download_url": "https://files.pythonhosted.org/packages/4c/db/73f46d2e053d981dfdb0426fd6b70bfb65b9d0323ad8f91d8e753fa7fd1c/pybmkg-2.0.0.tar.gz",
"platform": null,
"description": "# PyBMKG\n\n[![CI](https://github.com/kiraware/PyBMKG/workflows/ci/badge.svg)](https://github.com/kiraware/PyBMKG/actions/workflows/ci.yml)\n[![CodeQL](https://github.com/kiraware/PyBMKG/workflows/codeql/badge.svg)](https://github.com/kiraware/PyBMKG/actions/workflows/codeql.yml)\n[![Docs](https://readthedocs.org/projects/pybmkg/badge/?version=latest)](https://pybmkg.readthedocs.io/en/latest/?badge=latest)\n[![codecov](https://codecov.io/gh/kiraware/PyBMKG/graph/badge.svg?token=MN6AXAHO0P)](https://codecov.io/gh/kiraware/PyBMKG)\n[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)\n[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)\n[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)\n[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)\n[![pypi](https://img.shields.io/pypi/v/PyBMKG.svg)](https://pypi.org/project/PyBMKG/)\n[![python](https://img.shields.io/pypi/pyversions/PyBMKG.svg)](https://pypi.org/project/PyBMKG/)\n[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/license/mit/)\n\nThis is documentation for the `PyBMKG` project that\nis an asynchronous api wrapper written in Python for\n[open data](https://data.bmkg.go.id/) on weather\nforecasts and latest earthquakes in Indonesia served\nby Meteorology, Climatology and Geophysics Agency\n([BMKG](https://bmkg.go.id/)).\n\nPyBMKG was created as a wrapper to handle API requests\nBMKG open data asynchronously. This is because the\navailable API does not follow API standards in general,\ntherefore a wrapper was created which is expected to\nmake it easier to use the BMKG open data API with Python.\n\nWe use the third party library [aiohttp](https://docs.aiohttp.org/en/stable/)\nfor asynchronous client requests and it has been tested\nto work well using the [asyncio](https://docs.python.org/3/library/asyncio.html)\nlibrary. Also it use [dataclass](https://docs.python.org/3/library/dataclasses.html)\nas the schema.\n\n## Docs\n\nYou can start reading the documentation [here](https://pybmkg.readthedocs.io/en/latest/).\n\n## Contributing\n\nGlad to hear you want to contribute to PyBMKG. Please see\n[contributing guidelines](https://pybmkg.readthedocs.io/en/latest/how-to-guides/#contributing).\n\n## Acknowledgements\n\nWe would like to thank the Meteorology, Climatology\nand Geophysics Agency (BMKG) for its [open data service](https://data.bmkg.go.id/)\non weather forecasts and latest earthquake information.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python BMKG API Wrapper",
"version": "2.0.0",
"project_urls": {
"Bug Tracker": "https://github.com/kiraware/PyBMKG/issues",
"Documentation": "https://pybmkg.readthedocs.io/en/latest/",
"Homepage": "https://github.com/kiraware/PyBMKG",
"Repository": "https://github.com/kiraware/PyBMKG"
},
"split_keywords": [
"bmkg",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "93e591d516e4b1d75f035fc16ff7ba8b37b281df1c46e9703ced2b9b78bac524",
"md5": "244f7b656dd7a03128d91d157fad936a",
"sha256": "04f75cf4f1813de70c5a8e18ab11e5d56909ccd8ef9ab3fdcb7178ea4694580a"
},
"downloads": -1,
"filename": "pybmkg-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "244f7b656dd7a03128d91d157fad936a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11,<4.0",
"size": 32330,
"upload_time": "2024-02-16T04:35:35",
"upload_time_iso_8601": "2024-02-16T04:35:35.414551Z",
"url": "https://files.pythonhosted.org/packages/93/e5/91d516e4b1d75f035fc16ff7ba8b37b281df1c46e9703ced2b9b78bac524/pybmkg-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4cdb73f46d2e053d981dfdb0426fd6b70bfb65b9d0323ad8f91d8e753fa7fd1c",
"md5": "eb132f12073cd5df0727a364d0c72a23",
"sha256": "354431be8eb27945d63a01cee12f4cd0a492ea277cedc67b7c5d0ca61ddc80df"
},
"downloads": -1,
"filename": "pybmkg-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "eb132f12073cd5df0727a364d0c72a23",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11,<4.0",
"size": 17521,
"upload_time": "2024-02-16T04:35:37",
"upload_time_iso_8601": "2024-02-16T04:35:37.022391Z",
"url": "https://files.pythonhosted.org/packages/4c/db/73f46d2e053d981dfdb0426fd6b70bfb65b9d0323ad8f91d8e753fa7fd1c/pybmkg-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-16 04:35:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kiraware",
"github_project": "PyBMKG",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pybmkg"
}