docs: add Pl@ntNet to README (features, env vars, data sources)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Stephan Kerkman 2026-05-31 13:18:59 +02:00
parent b5cdda54f8
commit 1fe2b9fad8

View file

@ -2,12 +2,13 @@
A personal plant management web app built with Django 5, Bootstrap 5, and HTMX.
Track your plants, log pruning activity, and get care info auto-filled from the Perenual species database.
Track your plants, identify them by photo, and get care info auto-filled from the Perenual and Pl@ntNet APIs.
## Features
- **Species search** — search Perenual API by name; care data (watering, sunlight, pruning months) is auto-filled into the plant form and cached locally so the API is only called once per species
- **Plant list** — filterable by name, location, indoor/outdoor
- **Plant identification** — upload a photo; Pl@ntNet identifies it, shows top matches with reference images, pre-fills name and species, and saves the Pl@ntNet reference image as the plant thumbnail
- **Species search** — search Perenual API by name; care data (watering, sunlight, pruning months) is auto-filled and cached locally
- **Plant list** — filterable by name and location
- **Plant detail** — shows care info, pruning status, and pruning history
- **Pruning log** — log a pruning event with date and notes via HTMX partial update
- **Pruning calendar** — all plants grouped by urgency: overdue, due this month, due next month, later
@ -84,6 +85,7 @@ ssh dockerhost "cd /home/stephan/stacks/plantdb && docker compose up -d --build
| `ALLOWED_HOSTS` | yes | `localhost,127.0.0.1,dockerhost` |
| `CSRF_TRUSTED_ORIGINS` | yes (non-localhost) | `http://dockerhost:8083` |
| `PERENUAL_API_KEY` | no | `sk-...` |
| `PLANTNET_API_KEY` | no | `2b10...` (get at my.plantnet.org) |
`CSRF_TRUSTED_ORIGINS` is required when accessing the app on a non-standard port or hostname — Django 5 rejects POSTs without it.
@ -105,6 +107,7 @@ The app currently uses **Perenual** (free tier, 100 req/day) for species data. O
| **OpenFarm** | Shut down April 2025 | Dead. GitHub repo is a Ruby/MongoDB app with no data dump. |
| **Trefle** | Active | Botanical taxonomy only — no care schedules. Not a replacement. |
| **Wikipedia API** | Active | Returns name, description, thumbnail. No structured care data. |
| **Pl@ntNet** | Active | Plant identification from photos. Free tier: 500 req/day. Used for the identify-by-photo flow; reference image saved as plant thumbnail. |
| **Google Knowledge Panel** | N/A | Has structured care data but scraping violates ToS and is technically brittle. |
### Future opportunity