https://github.com/uburuntu/yaweather
☀️❄️ Yandex Weather API with typings and asyncio support
https://github.com/uburuntu/yaweather
api asyncio typing weather yandex
Last synced: 2 months ago
JSON representation
☀️❄️ Yandex Weather API with typings and asyncio support
- Host: GitHub
- URL: https://github.com/uburuntu/yaweather
- Owner: uburuntu
- License: mit
- Created: 2020-07-29T17:47:30.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-23T20:17:35.000Z (over 1 year ago)
- Last Synced: 2026-04-01T02:10:04.563Z (2 months ago)
- Topics: api, asyncio, typing, weather, yandex
- Language: Python
- Homepage: https://yandex.ru/dev/weather/
- Size: 786 KB
- Stars: 13
- Watchers: 2
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# YaWeather | Yandex Weather API
[]()
[](https://pypi.python.org/pypi/yaweather)
[](https://github.com/uburuntu/yaweather/blob/master/LICENSE)
[](https://travis-ci.org/uburuntu/yaweather)
☀️🌤🌧🌩❄️ Yandex Weather API wrapper with typings and asyncio support.
Docs: https://tech.yandex.com/weather/doc/dg/concepts/forecast-test-docpage ([RU](https://yandex.ru/dev/weather/doc/dg/concepts/forecast-test-docpage/))
Get API Key: https://developer.tech.yandex.ru/services/18
⚠️ **Warning**: As a developer of this library, I recommend you not to use Yandex Weather API, here are some reasons:
- Incomplete responses even for metropolises — you can [have a look](yaweather/models/forecast.py) to all `Optional` fields that I had to use in models, that means you should add `None` checks before access literally to any attribute
- Bad official documentation — for example, I [really had to](scripts/build_models.py) parse html code of doc pages just because tables copying was broken
- Incomprehensible and big delay answers from support team
- Few requests available — 50 per day on free rate and 5000 per day for one test month
- Closed information about real prices that are accessible only via support team
Consider usage of [OpenWeatherMap](https://openweathermap.org/api) with 1 mln free requests every month and really [good documentation](https://openweathermap.org/api/one-call-api) which easy to understand and parse.
## 📝 Table of Contents
- [🎒 Installation](#-installation)
- [🛠 Examples](#-examples)
- [Simple](#simple)
- [Simple Async](#simple-async)
- [Forecasts](#forecasts)
- [Forecasts Async](#forecasts-async)
- [📜 Manual](#-manual)
- [Methods](#methods)
- [Types](#types)
- [In case of unsupported types](#in-case-of-unsupported-types)
- [👨🏻💻 Author](#-author)
- [💬 Contributing](#-contributing)
- [📝 License](#-license)
---
## 🎒 Installation
Just
```
pip install yaweather
```
## 🛠 Examples
### Simple
```python3
from yaweather import UnitedKingdom, YaWeather
y = YaWeather(api_key='secret')
res = y.forecast(UnitedKingdom.London)
print(f'Now: {res.fact.temp} °C, feels like {res.fact.feels_like} °C')
print(f'Condition: {res.fact.condition}')
```
Output:
```text
Now: 18.0 °C, feels like 15.0 °C
Condition: cloudy
```
### Simple Async
```python3
import asyncio
from yaweather import Russia, YaWeatherAsync
async def main():
async with YaWeatherAsync(api_key='secret') as y:
res = await y.forecast(Russia.Moscow)
print(f'Now: {res.fact.temp} °C, feels like {res.fact.feels_like} °C')
print(f'Condition: {res.fact.condition}')
asyncio.run(main())
```
Output:
```text
Now: 16.0 °C, feels like 16.0 °C
Condition: clear
```
### Forecasts
```python3
from yaweather import UnitedStates, YaWeather
y = YaWeather(api_key='secret')
res = y.forecast(UnitedStates.NewYork)
for f in res.forecasts:
day = f.parts.day_short
print(f'{f.date} | {day.temp} °C, {day.condition}')
```
Output:
```text
2020-07-30 | 32.0 °C, cloudy
2020-07-31 | 26.0 °C, light-rain
2020-08-01 | 28.0 °C, cloudy
2020-08-02 | 28.0 °C, rain
2020-08-03 | 28.0 °C, light-rain
2020-08-04 | 27.0 °C, rain
2020-08-05 | 29.0 °C, light-rain
```
### Forecasts Async
```python3
import asyncio
from yaweather import China, YaWeatherAsync
async def main():
async with YaWeatherAsync(api_key='secret') as y:
res = await y.forecast(China.Beijing)
for f in res.forecasts:
day = f.parts.day_short
print(f'{f.date} | {day.temp} °C, {day.condition}')
asyncio.run(main())
```
Output:
```text
2020-07-31 | 34.0 °C, light-rain
2020-08-01 | 34.0 °C, cloudy
2020-08-02 | 30.0 °C, heavy-rain
2020-08-03 | 33.0 °C, cloudy
2020-08-04 | 35.0 °C, cloudy
2020-08-05 | 34.0 °C, light-rain
2020-08-06 | 31.0 °C, heavy-rain
```
## 📜 Manual
### Methods
API have one method:
* `forecast` — request for the forecast, return type: `ResponseForecast`
### Types
This library uses [pydantic](https://github.com/samuelcolvin/pydantic/) for parsing API responses.
You can see data models in [yaweather/models](yaweather/models).
### In case of unsupported types
API results can change and the library may not parse the new result. So you can request «raw» dicts:
```python3
raw_dict = y.forecast_raw(UnitedKingdom.London)
```
## 👨🏻💻 Author
**Ramzan Bekbulatov**:
- Telegram: [@rm_bk](https://t.me/rm_bk)
- Github: [@uburuntu](https://github.com/uburuntu)
## 💬 Contributing
Contributions, issues and feature requests are welcome!
## 📝 License
This project is [MIT](https://github.com/uburuntu/yaweather/blob/master/LICENSE) licensed.