effjot/ansiweather

Description

AnsiWeather is a Shell script for displaying the current weather conditions in your terminal, with support for ANSI colors and Unicode symbols.

Weather data comes from the OpenWeatherMap free weather API.

Requirements

AnsiWeather requires the following dependencies :

A command to fetch HTTP data such as cURL or wget
jq (lightweight and flexible command-line JSON processor)
bc (arbitrary precision numeric processing language)

Usage

After cloning the repository, simply invoke the script by typing :

./ansiweather

Command Line Options

Most configuration options may also be passed in as command line options:

-l city,CC: location
-u metric|imperial: units
-s true|false: Unicode symbols
-f n: forecast for day n
-d true|false: daylight (sunrise and sunset)

For example:

./ansiweather -l Moscow,RU -u metric -s true -f 5 -d true

Configuration

The following configuration options (detailed below) are available and should be set according to your location and preferences.

Config options can also be set in ~/.ansiweatherrc

Example : ~/.ansiweatherrc

location:Moscow,RU
fetch_cmd:ftp -V -o -
units:metric
daylight:true

Location

Location format is city,CC where CC is a two-letter ISO 3166-1 alpha-2 country code. A list of country codes is available here.

In case no location is specified, AnsiWeather will try to geolocate you using Telize.

Example : Moscow,RU

location:Moscow,RU

Fetch Command

Various tools can be used to fetch data : curl, wget, ftp.

Example : curl -s

fetch_cmd:curl -s

Example : wget -qO-

fetch_cmd:wget -qO-

Example : ftp -V -o -

fetch_cmd:ftp -V -o -

Default: curl -s

System of Units

Both metric and imperial systems are supported.

units:metric

Default: metric

Display symbols

Toggle Unicode symbols display. Value can be either true or false (requires an Unicode capable display).

symbols:true

Default: true

Display forecast

Show upcoming forecast for the next N days (for 0 <= N <= 7). 0 will show standard output.

forecast:5

Default: 0

Display sunrise / sunset

Toggle daylight display. Value can be either true or false.

daylight:false

Default: false

License

AnsiWeather is released under the BSD 3-Clause license. See LICENSE file for details.

Author

AnsiWeather is developed by Frederic Cambus

Site : http://www.cambus.net
Twitter: http://twitter.com/fcambus

Resources

GitHub : https://github.com/fcambus/ansiweather

effjot / ansiweather