diff --git a/Home.md b/Home.md new file mode 100644 index 0000000..df77f18 --- /dev/null +++ b/Home.md @@ -0,0 +1,35 @@ +# pronote-sync + +`pronote-sync` est un pipeline Python qui synchronise les données de **Pronote** (agenda et devoirs) vers un calendrier **CalDAV** et envoie des notifications via **XMPP**. Ce wiki s'adresse aux utilisateurs, administrateurs et contributeurs du projet. + +## Documentation + +- [Architecture](Architecture) — Pipeline, modules et flux de données +- [Configuration](Configuration) — Variables d'environnement et paramètres +- [Déploiement](Déploiement) — systemd, timer, logrotate et vérification des secrets +- [Sécurité](Sécurité) — Rédaction, `SecretStr`, `check_secrets` et bonnes pratiques + +## Démarrage rapide + +```bash +git clone https://git.antoineve.me/AntoineVe/college-infos +cd pronote-sync +python3.13 -m venv .venv +source .venv/bin/activate +pip install -e ".[dev]" +cp .env.example .env +pronote-sync --dry-run --log-level DEBUG +``` + +## Utilisation + +```bash +pronote-sync # Exécute la synchronisation +pronote-sync --dry-run # Simulation sans écriture +pronote-sync --log-level DEBUG # Verbosité des journaux +``` + +## Communauté + +- [Signaler un problème ou proposer une évolution](https://git.antoineve.me/AntoineVe/college-infos/issues) +- Licence : MIT \ No newline at end of file