Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/saaste/fmi-weather-client
Simple client library for fetching weather information from Finnish Meteorological Institute (FMI)
https://github.com/saaste/fmi-weather-client
Last synced: 3 months ago
JSON representation
Simple client library for fetching weather information from Finnish Meteorological Institute (FMI)
- Host: GitHub
- URL: https://github.com/saaste/fmi-weather-client
- Owner: saaste
- License: gpl-3.0
- Created: 2020-01-29T16:44:25.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-22T18:44:02.000Z (6 months ago)
- Last Synced: 2024-05-22T18:57:18.121Z (6 months ago)
- Language: Python
- Homepage:
- Size: 147 KB
- Stars: 15
- Watchers: 3
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- open-sustainable-technology - fmi-weather-client - Simple client library for fetching weather information from Finnish Meteorological Institute. (Atmosphere / Meteorological Observation and Forecast)
README
# Finnish Meteorological Institute Weather
Library for fetching weather information from
[Finnish Meteorological Institute (FMI)](https://en.ilmatieteenlaitos.fi/open-data).
If you want to know how FMI API works, you can check out their [WFS Examples and Guidelines](https://en.ilmatieteenlaitos.fi/open-data-manual-wfs-examples-and-guidelines) page.
For the current weather information, this library requests observations from the past `10` minutes using timestep `10`. Based on my tests this gave pretty reliable results from different weather stations.
Originally, I created this for myself to get FMI weather data to [Home Assistant](https://www.home-assistant.io/). I am not a meteorologist so if you are more weather-savvy, feel free to contribute and provide improvements! 💖
## How to use
Working example can be found in [example.py](example.py).
### Install
```
$ pip install fmi-weather-client
```
### Get weather and forecasts
You can get the weather using the following functions:
- `weather_by_place_name(place_name)`
- `weather_by_coordinates(latitude, longitude)`
Example:
```python
import fmi_weather_client as fmi
from fmi_weather_client.errors import ClientError, ServerError
try:
weather = fmi.weather_by_place_name("Jäppilä, Pieksämäki")
if weather is not None:
print(f"Temperature in {weather.place} is {weather.data.temperature}")
except ClientError as err:
print(f"Client error with status {err.status_code}: {err.message}")
except ServerError as err:
print(f"Server error with status {err.status_code}: {err.body}")
```
You can get the forecasts using the following functions:
- `forecast_by_place_name(place_name, [timestep_hours=24])`
- `forecast_by_coordinates(latitude, longitude, [timestep_hours=24])`
Example:
```python
import fmi_weather_client as fmi
from fmi_weather_client.errors import ClientError, ServerError
try:
forecast = fmi.forecast_by_coordinates(60.170998, 24.941325)
for weather_data in forecast.forecasts:
print(f"Temperature at {weather_data.time}: {weather_data.temperature}")
except ClientError as err:
print(f"Client error with status {err.status_code}: {err.message}")
except ServerError as err:
print(f"Server error with status {err.status_code}: {err.body}")
```
All functions have asynchronous versions available with `async_` prefix.
### Errors
##### ClientError
Happens if FMI service returns `400-499`. This can happens for example if:
- Provided coordinates are invalid
- Provided place is not recognized
- Weather data is not available
Error object contains status code and human-readable error message from FMI service.
##### ServerError
Happens if FMI service returns any other error.
Error object contains status code and raw response body from FMI service
### Weather data
FMI provides the following commonly used information:
- Temperature (°C)
- Pressure (hPa)
- Humidity (%)
- Wind direction (°)
- Wind speed (m/s)
- Wind gust (m/s)
- Dew point (°)
- Cloud coverage (%)
- Precipitation intensity (mm/h)
- Symbol [Documentation in Finnish](https://www.ilmatieteenlaitos.fi/latauspalvelun-pikaohje)
- Feels like temperature (°C), calculated from weather data [Documentation in Finnish](https://tietopyynto.fi/files/foi/2940/feels_like-1.pdf)
There are also other information available. Check [models.py](fmi_weather_client/models.py) and FMI documentation for
more info.
## Development
### Setup
Create and activate a virtual environment
```
$ python -m venv venv
$ source venv/bin/activate
```
Install required packages
```
$ make setup
```
Deactivate virtual environment when you are done
```
$ deactivate
```
### Run tests
This will run unit tests and code quality checks
```
$ make test
```