Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/noprobelm/tempy

A simple, visually pleasing weather report in your terminal.
https://github.com/noprobelm/tempy

Last synced: 3 months ago
JSON representation

A simple, visually pleasing weather report in your terminal.

Host: GitHub
URL: https://github.com/noprobelm/tempy
Owner: noprobelm
License: mit
Created: 2023-01-13T18:18:08.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2024-03-07T17:57:53.000Z (8 months ago)
Last Synced: 2024-06-28T07:35:24.964Z (5 months ago)
Language: Python
Size: 1.83 MB
Stars: 169
Watchers: 1
Forks: 0
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# tempy

![tempy](media/tempy.png)

`tempy` will render a simple, visually pleasing weather report for current and near-future conditions to your terminal.

`tempy` does not require an API key, but you can register one for yourself if you wish. See the section on [registering your own API key](#api-key-registry)

## Installation

```
pip install git+https://github.com/noprobelm/tempy
```

`tempy` is also available as `tempy-git` on the AUR.

## Usage

- Use `tempy nyc` to get the current weather for New York City

- Units are imperial by default. Specify the unit system you desire with the `-u` or `--units` flags: `tempy nyc -u metric`

![demo](media/demo.png)

## Configuration

When `tempy` runs, a skeleton configuration file will be created in `$HOME/.config/tempyrc`. You can specify `location`, `units`, and `api_key` options in this file to make `tempy` run on a default set of arguments.

## OPTIONAL: Registering your own API key

By default, `tempy` makes requests to the [https://www.weatherapi.com](https://www.weatherapi.com/) API endpoint via my proxy server at [http://www.noprobelm.dev](http://www.noprobelm.dev). This is to prevent you from needing to register your own API key.

If you'd rather not make requests through my server, you can always register your own key for free in minutes at [www.weatherapi.com](https://www.weatherapi.com/). Just store your key in `$HOME/.config/tempyrc` and `tempy` will take care of the rest.

# License