Skip to content

kiraware/PyBMKG

Repository files navigation

PyBMKG

CI CodeQL Docs codecov pre-commit security: bandit Checked with mypy Ruff pypi python License: MIT

This is documentation for the PyBMKG project that is an asynchronous api wrapper written in Python for open data on weather forecasts and latest earthquakes in Indonesia served by Meteorology, Climatology and Geophysics Agency (BMKG).

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 for asynchronous client requests and it has been tested to work well using the asyncio library. Also it use dataclass as the schema.

Docs

You can start reading the documentation here.

Contributing

Glad to hear you want to contribute to PyBMKG. Please see contributing guidelines.

Acknowledgements

We would like to thank the Meteorology, Climatology and Geophysics Agency (BMKG) for its open data service on weather forecasts and latest earthquake information.