diff --git a/README.md b/README.md index e743c05..b840992 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,68 @@ -# API to retrieve data from the Belgian IRM KMI in Python +# Async API to retrieve data from the Belgian IRM KMI in Python + +The package exposes the data from the [mobile application of the Belgian IRM KMI](https://www.meteo.be/en/info/faq/products-services/the-rmi-weather-app) as a python module. + +See more information in the wiki: https://github.com/jdejaegh/irm-kmi-api/wiki + +## Quick start example + +```python +import aiohttp +import asyncio +from zoneinfo import ZoneInfo +from irm_kmi_api import IrmKmiApiClientHa + +async def print_weather(): + session = aiohttp.ClientSession() + client = IrmKmiApiClientHa(session=session, user_agent="jdejaegh/irm-kmi-api README example", cdt_map={}) + await client.refresh_forecasts_coord({'lat': 50.47, 'long': 4.87}) + await session.close() + + weather = client.get_current_weather(tz=ZoneInfo('Europe/Brussels')) + city = client.get_city() + + print(f"{weather['temperature']}°C with wind of {weather['wind_speed']} km/h in {city}") + +if __name__ == '__main__': + asyncio.run(print_weather()) +``` + + +## Features + +The package provides the following: +1. Current weather +2. Hourly and daily forecast +3. Rain radar forecast and animation +4. Warning data (for extreme weather condition such as storm, thunder, floods) +5. Pollen data + +
+Screenshots of the rain radar animation +
+
+ +
+ +## Limitations + +The package does not provide the 14-days forcast as in the application. + +This package will not implement any feature that is not available via the API (e.g., humidity and dew point data is not +provided by the API and thus is not available in this package). + + +## Usage considerations + +The API is not publicly documented and has been reversed engineered: it can change at any time without notice and break this package. + +Be mindful when using the API: put a meaningful User-Agent string when creating an `IrmKmiApiClient` and apply rate-limiting for your queries. + + +## Contributions + +Contributions are welcome. Please discuss major changes in an issue before submitting a pull request. -The data is collected via their non-public mobile application API. ## Disclaimer diff --git a/img/camera_dark.png b/img/camera_dark.png new file mode 100644 index 0000000..27d3ccc Binary files /dev/null and b/img/camera_dark.png differ diff --git a/img/camera_light.png b/img/camera_light.png new file mode 100644 index 0000000..3397b96 Binary files /dev/null and b/img/camera_light.png differ diff --git a/img/camera_sat.png b/img/camera_sat.png new file mode 100644 index 0000000..b9e8310 Binary files /dev/null and b/img/camera_sat.png differ