https://github.com/zerowave022/yr-weather
Retrieve weather data from Norwegian Meteorological Institute's APIs easily.
https://github.com/zerowave022/yr-weather
api forecast met metno python weather weather-api yr yrno
Last synced: 12 days ago
JSON representation
Retrieve weather data from Norwegian Meteorological Institute's APIs easily.
- Host: GitHub
- URL: https://github.com/zerowave022/yr-weather
- Owner: ZeroWave022
- License: apache-2.0
- Created: 2023-01-21T21:11:34.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-11T20:15:48.000Z (over 1 year ago)
- Last Synced: 2025-02-08T14:18:09.723Z (3 months ago)
- Topics: api, forecast, met, metno, python, weather, weather-api, yr, yrno
- Language: Python
- Homepage: https://yr-weather.readthedocs.io
- Size: 228 KB
- Stars: 8
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# yr-weather
Retrieve weather data from Norwegian Meteorological Institute's APIs easily.
`yr-weather` is an API wrapper for some of the products from [MET's API](https://api.met.no/).
To see an example on how these APIs can be used, take a look at [Yr](https://www.yr.no/), made by MET and NRK.
**Available on [PyPI](https://pypi.org/project/yr-weather)**:
Supported products are:
- Locationforecast (v2.0)
- Radar (v2.0)
- Textforecast (v2.0)
- Sunrise (v3.0)
- Geosatellite (v1.4)
# Requirements
This package requires Python 3.8 or newer.
To download the newest version, visit [Python's website](https://www.python.org/downloads/).
# Installing
To use `yr-weather`, simply install it using `pip`.
For Windows:
```console
pip install yr-weather
```
For Linux/macOS:
```console
python3 -m pip install yr-weather
```
# Getting started
To get started, check out the [documentation](https://yr-weather.readthedocs.io/en/latest/gettingstarted.html).
For specific API Products, check their separate section on the documentation:
- [Locationforecast](https://yr-weather.readthedocs.io/en/latest/locationforecast/index.html)
- [Radar](https://yr-weather.readthedocs.io/en/latest/radar/index.html)
- [Textforecast](https://yr-weather.readthedocs.io/en/latest/textforecast/index.html)
- [Sunrise](https://yr-weather.readthedocs.io/en/latest/sunrise/index.html)
- [Geosatellite](https://yr-weather.readthedocs.io/en/latest/geosatellite/index.html)
For the best developer experience, all functions and classes are typed and documented with docstrings.
## Caching
By default, the library makes a cache file named `yr_cache.sqlite` in the working directory.
To disable caching, set `use_cache` to `False` like so:
```py
yr_weather.Locationforecast(headers=headers, use_cache=False)
```
MET's Terms of Service encourage using caching to avoid extra load on the network. Therefore, disabling caching and not implementing it yourself is not recommended.
# License
This project is licensed under the [Apache License 2.0](https://github.com/ZeroWave022/yr-weather/blob/main/LICENSE).
# Disclaimer
`yr-weather` is not associated with yr.no or the Norwegian Meteorological Institute (MET).
Any usage of the APIs provided by MET must follow their [API Terms of Service](https://api.met.no/doc/TermsOfService).