Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/sukhbinder/winzy-weather

Weather using the excellent wttr.in
https://github.com/sukhbinder/winzy-weather

Last synced: 2 days ago
JSON representation

Weather using the excellent wttr.in

Awesome Lists containing this project

README

        

# winzy-weather

[![PyPI](https://img.shields.io/pypi/v/winzy-weather.svg)](https://pypi.org/project/winzy-weather/)
[![Changelog](https://img.shields.io/github/v/release/sukhbinder/winzy-weather?include_prereleases&label=changelog)](https://github.com/sukhbinder/winzy-weather/releases)
[![Tests](https://github.com/sukhbinder/winzy-weather/workflows/Test/badge.svg)](https://github.com/sukhbinder/winzy-weather/actions?query=workflow%3ATest)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/sukhbinder/winzy-weather/blob/main/LICENSE)

Weather using the excellent [wttr.in](https://wttr.in/)

## Installation

First configure your Winzy project [to use Winzy](https://github.com/sukhbinder/winzy).

Then install this plugin in the same environment as your Winzy application.
```bash
pip install winzy-weather
```

## Usage

Usage instructions:

1. Run `winzy weather` to display the current weather.
2. To specify a city, use the `-c` or `--city` option followed by the city name. For example: `winzy weather -c London`.
3. To print in wide format, use the `-w` or `--wide` option.
4. To show the forecast without displaying the daily forecast, use the `-nf` or `--no-forecast` option.
5. To display today's forecast, use the `-t` or `--today` option.

```bash
winzy weather -c London -t
```
![London weather](london.png)

## Development

To set up this plugin locally, first checkout the code. Then create a new virtual environment:
```bash
cd winzy-weather
python -m venv venv
source venv/bin/activate
```
Now install the dependencies and test dependencies:
```bash
pip install -e '.[test]'
```
To run the tests:
```bash
python -m pytest
```