📝docs(docs): add documentation for README.md

add documentation in README.md, usage.md, architecture.md, update python version based on the version used in development
This commit is contained in:
2026-09-02 11:52:27 +02:00
parent a43afb9df7
commit bfa5fa600b
6 changed files with 340 additions and 10 deletions
+83
View File
@@ -0,0 +1,83 @@
# logwatcher
Logwatcher est un outil sur-mesure d'analyse et de tri automatique des logs LAME MDC pour le support N2.
Les techniciens N2 reçoivent quotidiennement des compte-rendus de suivi
d'imports NOSYMAG contenant des centaines de lignes d'erreurs. La plupart
ne les concernent pas. Logwatcher analyse ces compte-rendus, identifie
les erreurs pertinentes pour le support N2, et génère trois rapports
(n2, autres, tout) prêts à être transmis.
---
## 📦 Installation
### Prérequis
- Python >= 3.14
- `uv` (recommandé) ou `pip`
### Procédure
#### uv
```bash
uv pip install -e ".[dev]"
```
#### pip
```bash
pip install -e ".[dev]"
```
---
## 🚀 Commandes
### Analyser un fichier de logs
```bash
logwatcher --input-files chemin/vers/CR_fichier.txt
```
### Analyser tous les logs d'un répertoire
```bash
logwatcher --input-dir chemin/vers/dossier
```
### Afficher la version
```bash
logwatcher --version
```
Le guide complet se trouve dans [usage](docs/usage.md).
---
## 🏗️ Architecture
Le détail de l'architecture se trouve dans [architecture](docs/architecture.md).
---
## 🧪 Tests
Les tests se trouvent dans `tests/`. Le projet est couvert à ~95% par les tests unitaires et d'intégration.
### Lancer tous les tests
```bash
pytest
```
### Lancer un test spécifique (ex: `test_parser.py`)
```bash
pytest tests/test_parser.py
```
### Générer un rapport de couverture
```bash
pytest --cov=logwatcher --cov-report=term-missing
```
---
## 📄 Licence
MIT — voir [LICENSE](LICENSE).