IT-Stock/README.md
maxsoch a788bf4392 Résumé de stock dans les alertes + email récapitulatif planifié
L'alerte immédiate de stock bas inclut maintenant un résumé de tous les
articles actuellement sous leur seuil, pas seulement celui qui l'a
déclenchée. Ajout d'un second email, planifié via une expression cron
(RESUME_STOCK_CRON, APScheduler intégré à l'app — pas de cron système à
configurer) : stock bas en tête, puis le reste du stock groupé par
catégorie. scripts/envoyer_resume_stock.py permet de le déclencher
manuellement, ou de brancher l'envoi sur un cron système à la place.
2026-07-14 19:28:39 +02:00

110 lines
4.1 KiB
Markdown

# Gestion de stock IT
Application web pour le département IT d'une clinique, permettant de gérer
le stock de matériel informatique (catégories / sous-catégories /
matériels), avec scan de codes-barres et alertes email de stock bas.
Pas de système d'authentification dans l'app : l'accès est censé être
restreint par un mécanisme externe (réseau interne, proxy, etc.).
## Stack
- **Python + FastAPI** : serveur web, un seul processus.
- **SQLite** : base de données fichier (`data/stock.db`), aucun serveur à installer.
- **Jinja2** : pages HTML rendues côté serveur, formulaires classiques (pas de JS de build).
- **SQLModel** : ORM (combine SQLAlchemy + validation Pydantic).
Tout vit dans ce dossier : pas de service externe requis pour développer
et tester en local (les emails d'alerte sont simulés dans la console tant
qu'aucun SMTP n'est configuré, voir plus bas).
## Démarrer en local
```bash
python3 -m venv .venv
source .venv/bin/activate # Windows : .venv\Scripts\activate
pip install -r requirements-dev.txt
cp .env.example .env # optionnel en local, voir ci-dessous
uvicorn app.main:app --reload
```
L'app est accessible sur http://127.0.0.1:8000. La base SQLite est créée
automatiquement au premier démarrage dans `data/stock.db`.
## Lancer les tests
```bash
source .venv/bin/activate
pytest
```
## Lancer le linter
```bash
source .venv/bin/activate
ruff check .
```
## Configuration des emails
Les emails de stock (alerte immédiate + résumé périodique) sont envoyés via
le relais SMTP interne de la clinique, configuré par variables
d'environnement (voir `.env.example`) :
```
SMTP_HOST=...
SMTP_PORT=25
SMTP_USER=...
SMTP_PASSWORD=...
SMTP_FROM=stock-it@clinique.local
RESUME_STOCK_CRON=0 8 * * *
```
Si `SMTP_HOST` n'est pas renseigné (cas du dev local), rien n'est réellement
envoyé : les emails sont affichés dans la console du serveur
(`--- [EMAIL SIMULÉ] ---`). Ça permet de développer et tester tout le flux
sans avoir de vrai serveur mail sous la main.
Deux emails distincts :
- **Alerte immédiate** : envoyée dès qu'un matériel passe sous son seuil
d'alerte (`Materiel.seuil_alerte`). Contient ce matériel, puis un résumé
de tous les articles actuellement en stock bas.
- **Résumé périodique** : stock bas en premier, puis le reste du stock
groupé par catégorie. Planifié via `RESUME_STOCK_CRON` (expression cron
classique, ex. `0 8 * * *` = tous les jours à 8h) — le planificateur
tourne dans le process de l'app (APScheduler), rien à configurer côté
système. Pour le déclencher manuellement (test, ou pour le brancher sur
un cron système / Planificateur de tâches Windows à la place) :
`python scripts/envoyer_resume_stock.py`.
Les destinataires (plusieurs possibles) se gèrent sur `/destinataires`.
## Douchette code-barres
Aucune intégration logicielle particulière : une douchette USB (ou
Bluetooth) émule un clavier, elle "tape" le code puis Entrée. La page
`/scan` a un simple champ de texte auto-focus dans un formulaire ; Entrée
soumet automatiquement le formulaire.
## Structure du projet
```
app/
main.py point d'entrée FastAPI, démarrage du planificateur
config.py lecture des variables d'environnement
database.py connexion SQLite
models.py modèles SQLModel (Categorie en arborescence, Materiel, DestinataireAlerte)
categories_arbre.py parcours de l'arborescence de catégories
email_alerts.py alerte immédiate + résumé périodique de stock
scheduler.py planification (APScheduler) du résumé périodique
templates_engine.py instance Jinja2Templates partagée
routers/ une route FastAPI par ressource (categories, materiels, scan, destinataires)
templates/ pages HTML (Jinja2)
static/ CSS
scripts/
seed.py peuple la base avec des données de démo
envoyer_resume_stock.py déclenche manuellement l'email récapitulatif
tests/ tests pytest (client de test FastAPI + base SQLite en mémoire)
data/ base SQLite locale (ignorée par git)
```