trmnl-report/README.md

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:

   python -m venv .venv
   source .venv/bin/activate
   uv sync
   

2. set required environment variables:

   export WEATHER_API_KEY="your_openweathermap_api_key"
   export AUTH_TOKEN="your_chosen_auth_token"
   

3. run the application:

   fastapi run main.py --port 8887
   

development

install development dependencies

make dev-install

docker

build and run with docker:

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