Skip to content

Commit

Permalink
Updated: README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
egargo committed Nov 8, 2021
1 parent 233ac03 commit 1b93121
Showing 1 changed file with 24 additions and 14 deletions.
38 changes: 24 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<div align="center">
<h1>pwy</h1>
<p>A simple weather tool.</p>
<img src="https://raw.githubusercontent.com/noqqlint/noqqlint.github.io/master/images/pwy.png"><br>
<p>A simple weather information tool.</p>
<img src="https://raw.githubusercontent.com/cliegargo/cliegargo.github.io/master/images/pwy.png"><br>
<a href="https://pypi.org/project/pwy"><img src="https://img.shields.io/pypi/v/pwy"></a>
<a href="https://openweathermap.org/api"><img src="https://img.shields.io/badge/openweathermap-api-blue"></a>
<a href="#"><img src="https://static.pepy.tech/personalized-badge/pwy?period=total&units=none&left_color=grey&right_color=blue&left_text=downloads"></a>
<a href="https://github.com/noqqlint/pwy/blob/master/LICENSE"><img src="https://img.shields.io/pypi/l/pwy?color=blue"></a>
<a href="https://github.com/cliegargo/pwy/blob/master/LICENSE"><img src="https://img.shields.io/pypi/l/pwy?color=blue"></a>
</div>


Expand All @@ -25,7 +25,7 @@
* Display weather information
* The name of the location.
* Temperature (and what the temperature feels like).
* Weather and weahter description.
* Weather and weather description.
* Wind pressure, humidity, wind direction, and wind speed.
* Time and timezone of the location.

Expand All @@ -35,6 +35,7 @@
* Python 3.8
* requests
* rich
* Internet connection


## Installation
Expand All @@ -47,31 +48,40 @@ pip3 install pwy
### Manual/Git install
#### Unix-like | Windows

Download the latest pwy package [here](https://github.com/noqqlint/pwy/releases/latest) and uncompress it.
Download the latest pwy package [here](https://github.com/cliegargo/pwy/releases/latest) and uncompress it.
Go to pwy directory.
```sh
cd pwy
```
Install pwy.
```
```sh
pip3 install .
```


## Configuration
### Unix-like | Windows
Before you can use pwy, you need to configure your OWM API key first. After you're through, the `pwyrc` (`~/.config/pwyrc` for Unix-like and `.pwyrc` for Windows) config file, containing your OWM API key will be generated. Get your OWM key by [signing up](https://home.openweathermap.org/users/sign_up).
Before you can use pwy, you need to configure pwy. Run the command below and fill the required files, these fields are for the OWM API key, location, unit, and language.
```sh
pwy
```
After you're through, the `pwy.json` (`~/.config/pwy.json` for Unix-like and `pwy.json` for Windows) config file, containing your OWM API key, location, unit, and language, will be generated.

* After creating your OWM API key you have to wait a couple of minutes for your API key to activate.
* This only applies to Unix-like users: If you just install pwy version 1.4.3, please delete the `.pwyrc` in your home director.
Configure pwy with your OWM API key.
Get your OWM key by [signing up](https://home.openweathermap.org/users/sign_up).

If you want to edit your pwy configuration.
```sh
pwy --config XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
pwy --config
```


## Usage
### Unix-like | Windows
To display weather in your current city (from pwy.json).
```sh
pwy
```

To display weather in your current city.
```sh
pwy tokyo
Expand Down Expand Up @@ -104,14 +114,14 @@ pip3 install --upgrade pwy


## Changelog
View [Changelog](https://github.com/noqqlint/pwy/blob/master/CHANGELOG.md).
View [Changelog](https://github.com/cliegargo/pwy/blob/master/CHANGELOG.md).


## Credits
* [pwy Contributors](https://github.com/noqqlint/pwy/graphs/contributors)
* [pwy Contributors](https://github.com/cliegargo/pwy/graphs/contributors)
* [OpenWeatherMap](https://openweathermap.org/current) - API
* [wego](https://github.com/schachmat/wego) - ASCII art


## License
This program is provided under the [GPL-3.0 License](https://github.com/noqqlint/pwy/blob/master/LICENSE).
This program is provided under the [GPL-3.0 License](https://github.com/cliegargo/pwy/blob/master/LICENSE).

0 comments on commit 1b93121

Please sign in to comment.