Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jason0x43/alfred-weather

Get weather forecast using Alfred
https://github.com/jason0x43/alfred-weather

Last synced: 3 days ago
JSON representation

Get weather forecast using Alfred

Awesome Lists containing this project

README

        

# alfred-weather

An [Alfred][alfred] workflow for showing weather forecasts

![Screenshot](doc/daily.png?raw=true)

This workflow lets you access weather forecasts from several APIs:

- [Tomorrow.io][tomorrowio]
- [OpenWeather][openweather]

---

## Installation

Download the latest workflow package from the
[releases page](https://github.com/jason0x43/alfred-weather/releases) and double
click it — Alfred will take care of the rest.

## Setup

The workflow has one top-level command, `wtr`, and three sub-commands, daily
(`wtd`), hourly (`wth`), and options (`wto`). The first thing you'll need to do
is configure some options.

![Options](doc/options.png?raw=true)

Some options are, well, optional, but the Service and related Key options, and a
default location, are required. You need an API key for the service you choose.
Both of the currently supported services (OpenWeather and Tomorrow.io) are free
to use (for a reasonable number of requests per day).

- [OpenWeather API](https://openweathermap.org/api)
- [Tomorrow.io API](https://docs.tomorrow.io/reference/weather-forecast)

Once you've entered the service key, selection the "Location" option then enter
a ZIP code or city name, then wait a couple of seconds. When it looks like your
desired location has been found, press Enter to save it.

## Usage

The `wtd` keyword will show a forecast for the next several days.

![Daily forecast](doc/daily.png?raw=true)

The `wth` keyword will show a forecast for the next several hours.

![Hourly forecast](doc/hourly.png?raw=true)

In either case, you can enter a location query to get the forecast for somewhere
other than your default location.

![Name query](doc/daily_name.png?raw=true)

![ZIP query](doc/daily_zip.png?raw=true)

Actioning a day in the daily forecast will jump to an hourly forecast for that
day, if hourly data is available. Actioning the list heading will jump back to
the daily forecast.

If there are any active weather alerts, they'll show at the top of the forecast.
Actioning an alert will open more detailed information in a browser window.

If there is a newer version of the workflow available, a message will be
displayed at the top of the result list. Actioning it will open a release page
for the new version in a browser window.

![Update notice](doc/update.png?raw=true)

## Credits

The package includes a number of icon sets from the [Weather Underground](wund)
and from [weathericonsets.com][icons] (I'm not up to drawing weather icons yet).
Each set includes an `info.json` file that gives a short description and
provides a source URL for the icon set.

[alfred]: https://www.alfredapp.com
[icons]: https://www.weathericonsets.com
[wund]: https://www.weatherunderground.com
[openweather]: https://openweathermap.org
[tomorrowio]: https://tomorrow.io