Files
weather/README
Jeremy Stanley 4d25a49d5a Imported from archive.
* Release 1.5.

* (all): Updated copyright notices for 2010.

* FAQ, INSTALL, LICENSE, README: Reformatted as ReStructuredText.

* FAQ: Updated to mention alternative sources for NOAA's stations
list, in case the recommended one is unavailable (thanks Celejar!).

* NEWS: Renamed to ChangeLog and refactored into GNU format.

* weather: Added some comment padding between the shebang line and
the copyright, so that distributions wishing to carry patches which
modify the interpreter path don't have to refresh them every year
when the copyright line changes in their context.

* weather, weather.1, weatherrc.5, weather.py: Added experimental
alert, atypes, aurl and zones options to support retrieval,
filtering and formatting of unexpired NWS severe weather advisories.

* weather.1, weatherrc.5: Minor cosmetic fixes to option
descriptions.

* weather.1, weatherrc.5, weather.py: Added imperial and metric
options to filter/convert display units (thanks to Andrew Carter for
this suggestion!).

* weather.py: Fixed a METAR parsing error which would trigger an
IndexError exception if the NWS didn't have a station description on
file (thanks to Celejar for reporting the bug!). Fixed METAR title
line parsing to look for human-readable city and state in the first
line--previous code stopped showing the city name after NWS made
slight format mods. Upped the version to 1.5.

* weatherrc: Additional PIE (Saint Petersburg, FL), PNC (Ponca City,
OK), and PNS (Pensacola, FL) aliases.
2010-03-19 13:30:22 +00:00

49 lines
2.1 KiB
Plaintext

===============================================
General Information About the Weather Utility
===============================================
:Copyright: (c) 2006-2010 Jeremy Stanley <fungi@yuggoth.org>. Permission to
use, copy, modify, and distribute this software is granted under
terms provided in the LICENSE file distributed with this software.
.. contents::
What?
-----
This command-line utility is intended to provide quick access to current
weather conditions and forecasts. Presently, it is capable of returning data
for localities throughout the USA by retrieving and formatting decoded METARs
(Meteorological Aerodrome Reports) from NOAA (the USA National Oceanic and
Atmospheric Administration) and forecasts from NWS (the USA National Weather
Service). The tool is written to function in the same spirit as other
command-line informational utilities like cal(1), calendar(1) and dict(1). It
can retrieve arbitrary weather data via specific command-line switches (station
ID, city, state), or aliases can be configured system wide and on a per-user
basis. It can be freely used and redistributed under the terms of a BSD-like
License.
Why?
----
My girlfriend had a long commute to/from work and school, and often wanted to
check the weather both for home and her office. Unfortunately, starting a Web
browser, pulling up a weather site, entering multiple ZIP codes and waiting for
them to load is time-consuming for the marginally-impatient. Since she tended
to stay logged into a shell server most of the time, I figured I'd install a
quick command-line tool to retrieve weather info for her commute, but to my
surprise, a quick search turned up little that met my basic requirements:
* retrieve current data on-demand
* provide both current conditions and short-term forecasts
* simple, human-readable output
* easy to configure and use
* flexible command-line switches and options
Where?
------
A tarball for the most recent version of the weather utility can be had here:
* http://fungi.yuggoth.org/weather/src/
Alternatively, Debian and Ubuntu users can install the weather-util package
from any mirror.