Architecture-du-logiciel.md

+Liste des fichiers et répertoires du projet:
+
+| Fichier | Description |
+|---------|-------------|
+| `.flake8` | Configuration de flake8, le vérificateur PEP8 |
+| `.gitignore` | Liste des fichiers/dossiers ignorés par git |
+| `.gitlab-ci.yml` | Configuration des suites de tests unitaires GitLab |
+| `Cargo.lock` | Verrou de version des dépendances rust |
+| `Cargo.toml` | Spécification des versions des dépendances rust |
+| `COPYING` | License GNU GPLv3 |
+| `README.md` | Informations rapides |
+| `requirements.txt` | Spécification des versions des dépendances python |
+| `run.sh` | Script de lancement du client. Lancer avec l'option `-d` ou `--dev` pour le mode de développement |
+| `template.py` | Modèle d'en-tête de fichier python |
+
+# Application
+
+| Fichier | Description |
+|---------|-------------|
+| `agios.py` | Script de prélèvement des agios. Lancé par une tache cron via `bin/agios.sh` |
+| `database.py` | Outils d'accès à la BdD depuis python |
+| `local_settings.py` | Fichier de paramètres locaux, non synchronisé dans git, généré par `bin/setup.py` |
+| `mail.py` | Script d'envoi des mails automatiques. Lancé par une tache cron via `bin/mail.sh` |
+| `main.py` | Fichier principal de l'application. C'est l'exécutable lancé par `run.sh` |
+| `photo_sync.py` | Script de synchronisation des photos de profil. **Depuis où est-il lancé ?** |
+| `settings.py` | Paramètres par défaut et synchro des paramètres via redis |
+
+## `local_settings.py`
+
+Fichier de paramètres locaux, non synchronisé dans git, généré par `bin/setup.py`
+
+Contient un contenu similaire à
+```python
+DEBUG = False
+IMG_BASE_DIR = "img/"
+MAX_HISTORY = 5
+REDIS_HOST = "127.0.0.1"
+REDIS_PASSWORD = None
+```
+
+La valeur intéressante est `DEBUG`. Si on la met à `True`, le logiciel ne demande aucun mots de passe.
+
+**C'est pour cela qu'il faut s'assurer qu'en prod, seuls les personnes habilitées peuvent le modifier !**
+
+## API
+
+Backend du client.
+
+## GUI
+
+Scripts python de l'interface graphique, code front.
+
+## Img
+
+Stockage des photos de profil
+
+## RAPI
+
+API Rust
+
+## UI
+
+Fichiers Qt de description de l'interface graphique.
+
+# Bin
+
+Scripts utilitaires
+
+| Fichier | Description |
+|---------|-------------|
+| `agios.sh` | Prélèvement des agios |
+| `mail.sh` | Envoi des mails automatiques |
+| `migrations.py` | Mise à jour de la base de données avec les changement de modèle |
+| `setup.py` | Création de la configuration locale, et, si besoin, de la configuration synchronisée via redis |
+| `test.sh` | Lancement des tests unitaires |
+| `update.sh` | Mise à jour du logiciel depuis le dépot git |
+
+## `migrations.py`
+
+Mise à jour de la base de données avec les changement de modèle.
+
+| Commande | Effet |
+|----------|-------|
+| `migrations.py apply` | Mise en place des migrations |
+| `migrations.py new <name>` | Création de nouveaux fichiers de migration avec pour nom `<name>`. Il faut ensuite les peupler à la main. |
+| `migrations.py rollback` | Annule la dernière migration |
+
+## Utils
+
+Scripts utiles dans certains cas très particuliers.
\ No newline at end of file