OpenWeatherWidget/README.md
2025-09-19 17:52:38 +05:30

1.4 KiB

OpenWeatherWidget

Minimal weather widget for your desktop updates using the OpenWeatherMap API.

Status

⚠️ Work in progress - not ready for general use.

Configuration

The widget reads configuration from:

~/.config/candywidgets/openweathermap.toml

Example:

[general]
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"

⚠️ WIP - Full configuration format will be released later.

API

  • Currently uses the Free API v2.5. Find details on Postman.
  • One Call API 3.0 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

  • TOML configuration file
  • Fetch and parse current weather data from openweathermap.org
  • Weather forecast query
  • Complete configuration
  • CLI args
  • GUI - iced
  • Icons
  • Support One Call API 3.0

Low-probability To-do

  • Historical weather query
  • Weather maps