43 lines
No EOL
824 B
Markdown
43 lines
No EOL
824 B
Markdown
# trmnl weather & pollen report
|
|
|
|
a custom trmnl plugin that fetches and displays weather and pollen data.
|
|
|
|
## setup
|
|
|
|
1. set up a virtual environment and install dependencies:
|
|
```bash
|
|
python -m venv .venv
|
|
source .venv/bin/activate
|
|
uv sync
|
|
```
|
|
|
|
2. set required environment variables:
|
|
```bash
|
|
export WEATHER_API_KEY="your_openweathermap_api_key"
|
|
export AUTH_TOKEN="your_chosen_auth_token"
|
|
```
|
|
|
|
3. run the application:
|
|
```bash
|
|
fastapi run main.py --port 8887
|
|
```
|
|
|
|
## development
|
|
|
|
### install development dependencies
|
|
|
|
```bash
|
|
make dev-install
|
|
```
|
|
|
|
## docker
|
|
|
|
build and run with docker:
|
|
```bash
|
|
docker build -t trmnl-report .
|
|
docker run -p 8887:8887 -e WEATHER_API_KEY=your_key -e AUTH_TOKEN=your_token trmnl-report
|
|
```
|
|
|
|
## api
|
|
|
|
access the api at `http://localhost:8887/?token=your_auth_token` |