52 lines
1.5 KiB
Markdown
52 lines
1.5 KiB
Markdown
# OpenWeatherWidget
|
|
|
|
Minimal weather widget for your desktop updates using the [OpenWeatherMap](https://openweathermap.org) API.
|
|
|
|
## Status
|
|
⚠️ Work in progress - not ready for general use.
|
|
|
|
## Configuration
|
|
The widget reads configuration from:
|
|
|
|
```
|
|
~/.config/candywidgets/openweathermap.toml
|
|
````
|
|
|
|
Example:
|
|
|
|
```toml
|
|
[general]
|
|
api_version = "free_2.5" # Other APIs are WIP
|
|
|
|
[query_params]
|
|
api_key = "your_api_key_here" # Get a free API key from https://openweathermap.org
|
|
city_id = "your_city_id_here" # Find it in the url of your city at https://openweathermap.org/find?
|
|
units = "metric"
|
|
lang = "en"
|
|
````
|
|
⚠️ WIP - Full configuration format will be released later.
|
|
|
|
## API
|
|
|
|
- Currently supports the [Free API v2.5](https://openweathermap.org/appid). Find details on [OWM](https://openweathermap.org/current) or [Postman](https://www.postman.com/api-evangelist/openweathermap/request/9dt1g2m/call-current-weather-data-for-one-location).
|
|
- [One Call API 3.0](https://openweathermap.org/api/one-call-3) is free for up to 1000 API calls per day, but requires payment information for subscription.
|
|
- Support for student plan may be considered later.
|
|
- Support for One Call v3.0 may be considered later.
|
|
|
|
## To-do
|
|
|
|
- [x] TOML configuration file
|
|
- [x] Fetch and parse current weather data from OWM
|
|
- [ ] Weather forecast query
|
|
- [ ] Complete library
|
|
- [ ] Complete configuration
|
|
- [ ] CLI args
|
|
- [ ] GUI - [iced](https://book.iced.rs/)
|
|
- [ ] Icons
|
|
- [ ] Support One Call API 3.0
|
|
|
|
# Low-probability To-do
|
|
|
|
- [ ] Historical weather query
|
|
- [ ] Weather maps
|