Skip to content

Commit

Permalink
Update readme. Drop pipenv.
Browse files Browse the repository at this point in the history
  • Loading branch information
ways committed Oct 3, 2024
1 parent 59d645c commit f63397a
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 182 deletions.
18 changes: 0 additions & 18 deletions Pipfile

This file was deleted.

154 changes: 0 additions & 154 deletions Pipfile.lock

This file was deleted.

19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,15 @@ An ascii version of Yr.no's meteogram <https://www.yr.no/en/forecast/graph/1-728

## Usage

Finger is supported on all major platforms (Windows, OS X, Linux, FreeBSD, Android, ...). Open up your terminal (or cmd.exe on Windows).
If you just want to use the service, type: `finger [email protected]` (replace oslo with your city). Finger is supported on all major platforms (Windows, MacOS, Linux, FreeBSD, Android, ...).

If you don't have finger available, but have some standard shell tools, try one of the following:

echo oslo|nc graph.no 79
telnet graph.no 79 (and then type oslo)

If you want to run the server yourself, read on below.

## Example output

$ finger [email protected]
Expand All @@ -39,8 +41,7 @@ If you don't have finger available, but have some standard shell tools, try one

## Techs

* Python3
* [Pipenv](https://pipenv.pypa.io/) for deps control
* Python
* geopy for location look-up via nominatim
* metno-locationforecast as met.no API lib <https://github.com/Rory-Sullivan/metno-locationforecast/>
* redis for caching location lookups.
Expand All @@ -52,18 +53,16 @@ Contributions from:
* <https://github.com/neo954>
* <https://github.com/sotpapathe>

## Server install
## Server install or running locally

User docker compose or:
User docker compose:

* use pipenv for python and dependencies.
* Redis server, set to drop stuff when full.
* Periodically clean old files in data/
* `docker compose up`

## Testing

- python3 -m unittest discover -v -p test/__init__.py
- Run a local redis for development and testing: `docker run -it --rm -p 6379:6379 redis`
- create a venv and install tox
- Run `tox`

## More

Expand Down

0 comments on commit f63397a

Please sign in to comment.