weather-command 1.0.1

Command line weather app

Weather Command

A command line weather app

Installation

Installation with pipx is recommended.

pipx install weather-command

Alternatively Weather Command can be installed with pip.

pip install weather-command

Usage

First an API key is needed from OpenWeather, A free account is all that is needed. Once you have your API key create an environment variable named OPEN_WEATHER_API_KEY that constains your API key.

export OPEN_WEATHER_API_KEY=your-api-key

Each time the shell is restarted this variable will be cleared. To avoid this it can be added to your profile. For example if your shell is zsh the API key can be added to the ~/.zshenv file. Doing this will prevent the need to re-add the key each time the shell is started.

To get the weather for a city:

weather-command city seattle

Once installed you can also add aliases to your shell to make it quick to get a forecast. For example if your shell is zsh you can add something like the following to your ~/.zshrc file:

alias we="weather-command zip 98109 -i --am-pm"
alias wed="weather-command zip 98109 -i --am-pm -f daily"
alias weh="weather-command zip 98109 -i --am-pm -f hourly"

After adding this to the ~/.zshrc you will need to restart your terminal. After that typing we will get the current forecast, wed will get the daily forecast and weh will get the hourly forecast.

Arguments

• [HOW]: How to get the weather. Accepted values are city and zip. [default: city]
• [CITY_ZIP]: The name of the city or zip code for which the weather should be retrieved. If the first argument is 'city' this should be the name of the city, or if 'zip' it should be the zip code. [required]

Options

• -s, --state-code: The name of the state where the city is located.
• -c, --country-code: The country code where the city is located.
• -i, --imperial: If this flag is used the units will be imperial, otherwise units will be metric.
• --am-pm: If this flag is set the times will be displayed in 12 hour format, otherwise times will be 24 hour format.
• -f, --forecast-type: The type of forecast to display. Accepted values are 'current' 'daily', and 'hourly'. [default: current]
• -t, --temp-only: If this flag is set only tempatures will be displayed.
• --terminal_width INTEGER: Allows for overriding the default terminal width.
• --help: Show this message and exit.

Contributing

Contributions to this project are welcome. If you are interesting in contributing please see our contributing guide