Files
tempus/README.md
T
2026-10-26 13:21:14 +01:00

64 lines
2.8 KiB
Markdown

# Tempus
Time tracker local pour suivre le temps passé sur chaque projet de chaque client.
Un seul binaire Rust (axum + SQLite) qui sert une interface web et une API JSON.
## Lancer
```sh
cargo run --release
# → http://127.0.0.1:7878
```
| Variable | Défaut | Rôle |
|---------------|------------------------------------------|------------------------------------|
| `TEMPUS_DB` | `~/.local/share/tempus/tempus.db` | Chemin (ou URL `sqlite:`) de la base |
| `TEMPUS_ADDR` | `127.0.0.1:7878` | Adresse d'écoute |
| `RUST_LOG` | `tempus=info,tower_http=info` | Niveau de logs |
Aucune authentification : le service est prévu pour tourner en local.
## Pages
- `/` — timer (démarrer / basculer / arrêter) et entrées du jour
- `/entries` — liste filtrable, saisie manuelle, édition inline (⚠ = chevauchement)
- `/reports` — totaux par client, projet ou jour sur une période
- `/clients` — clients et projets (nom, couleur, archiver, supprimer)
## API JSON (`/api`)
| Méthode | Route |
|--------------|----------------------------------------------------|
| GET, POST | `/clients` (`?archived=true` pour inclure les archivés) — `{"name", "color"?}` |
| PATCH, DELETE| `/clients/{id}` — `{"name"?, "archived"?, "color"?}` |
| GET, POST | `/clients/{id}/projects` — `{"name", "color"?}` |
| PATCH, DELETE| `/projects/{id}` — `"color": null` pour reprendre celle du client |
| GET | `/timer` — entrée en cours ou `null` |
| POST | `/timer/start` `{"project_id", "note"?}` · `/timer/stop` |
| GET, POST | `/entries` (`?from&to&client_id&project_id`) |
| PATCH, DELETE| `/entries/{id}` |
| GET | `/reports?from&to&group_by=client\|project\|day&client_id&project_id` |
Les couleurs sont au format `#rrggbb`. Un client reçoit automatiquement une couleur
de la palette s'il n'en précise pas ; un projet sans couleur utilise celle de son client
(`effective_color` dans les réponses).
Les dates d'entrées sont en RFC 3339 (`2026-10-26T09:00:00+01:00`) ; les périodes
(`from`, `to`, inclusives) sont des dates `YYYY-MM-DD` dans le fuseau local.
```sh
curl -XPOST localhost:7878/api/clients -H 'content-type: application/json' -d '{"name":"Acme"}'
curl -XPOST localhost:7878/api/timer/start -H 'content-type: application/json' -d '{"project_id":1}'
```
## Développement
```sh
cargo test
cargo clippy --all-targets -- -D warnings
```
Le schéma est dans `migrations/` (appliqué automatiquement au démarrage).
Les horodatages sont stockés en UTC au format fixe `YYYY-MM-DDTHH:MM:SSZ`
(voir `src/clock.rs`) pour que les comparaisons SQL sur le texte restent valides.