Stéphan Peccini
f812fac89e
Cette mise a jour complete ameliore significativement la qualite et la maintenabilite du projet. 1. Extension de la couverture de tests Couverture globale passee de 8% a 16% (+100%) - Ajout de 25 nouveaux tests (total: 67 tests, 100% passent) - Nouveaux fichiers de tests: * tests/unit/test_gitea.py (17 tests) * tests/unit/test_fiches_tickets.py (8 tests) Etat de la couverture par module: - utils/gitea.py: 100% - utils/widgets.py: 100% - utils/logger.py: 94% - app/fiches/utils/tickets/core.py: 77% - utils/graph_utils.py: 59% 2. Documentation d'architecture complete Creation de 3 nouveaux documents (30 Ko total): - docs/ARCHITECTURE.md (15 Ko) * Architecture complete du projet * Flux de donnees detailles * Indices de vulnerabilite (IHH, ISG, ICS, IVC) * Structure du graphe NetworkX - docs/MODULES.md (15 Ko) * Guide des 11 modules principaux * Exemples de code (15+ snippets) * Bonnes pratiques * Guide de depannage - docs/README.md (4 Ko) * Index de toute la documentation Contenu documente: - 5 modules applicatifs - 6 modules utilitaires - 4 indices de vulnerabilite avec formules et seuils - Conventions de code 3. Reorganisation de la documentation Structure finale optimisee: - Racine: README.md (mis a jour) + Instructions.md - docs/: 11 documents organises par categorie Fichiers deplaces vers docs/: - README_connexion.md -> docs/CONNEXION.md - GUIDE_LOGS.md -> docs/ - GUIDE_RUFF.md -> docs/ - RAPPORT_RUFF.md -> docs/ - RAPPORT_CORRECTIONS_AUTO.md -> docs/ - REFACTORING_REPORT.md -> docs/ - VERIFICATION_LOGS.md -> docs/ - TODO_IA_BATCH.md -> docs/ 4. Ajout de docstrings 52 fonctions documentees en style Google (100%) Documentation en francais avec Args, Returns, Raises 5. Corrections automatiques Ruff Application de 347 corrections automatiques: - Formatage du code (line-length: 120) - Organisation des imports - Simplifications syntaxiques - Suppressions de code mort - Ameliorations de performance 6. Configuration qualite du code Nouveaux fichiers: - pyproject.toml: configuration Ruff complete - .vscode/settings.json: integration Ruff avec formatOnSave - GUIDE_RUFF.md: documentation du linter - GUIDE_LOGS.md: documentation du logging - .gitignore: ajout htmlcov/ pour rapports de couverture Etat final du projet: - Linter: Ruff configure (15 regles actives) - Tests: 67 tests (100% passent) - Couverture de code: 16% - Docstrings: 52/52 (100%) - Documentation: 11 fichiers organises Impact: - Tests plus robustes et maintenables - Documentation technique complete - Meilleure organisation des fichiers - Workflow optimise avec Ruff - Code pret pour integration continue References: - Architecture: docs/ARCHITECTURE.md - Guide modules: docs/MODULES.md - Tests: tests/unit/ - Configuration: pyproject.toml Co-Authored-By: Claude <noreply@anthropic.com>
4.1 KiB
4.1 KiB
Documentation FabNum
Bienvenue dans la documentation du projet FabNum !
📚 Table des matières
Documentation technique
-
ARCHITECTURE.md - Architecture complète du projet
- Vue d'ensemble de l'application
- Structure des modules
- Flux de données
- Indices et métriques (IHH, ISG, ICS, IVC)
- Tests et couverture
- Roadmap
-
MODULES.md - Guide des modules et API
- Modules applicatifs (analyse, fiches, plan d'action)
- Utilitaires (gitea, graph_utils, logger, etc.)
- Exemples de code
- Bonnes pratiques
- Guide de dépannage
Guides de développement
-
GUIDE_RUFF.md - Guide d'utilisation de Ruff
- Configuration du linter
- Règles activées
- Commandes utiles
- Intégration IDE
-
GUIDE_LOGS.md - Guide du système de logging
- Configuration des loggers
- Niveaux de log
- Visualisation des logs
- Bonnes pratiques
Rapports et refactoring
-
REFACTORING_REPORT.md - Rapport de refactoring global
- Corrections apportées
- Améliorations de structure
- Impact sur la qualité du code
-
RAPPORT_RUFF.md - Rapport d'analyse Ruff
- Problèmes détectés
- Catégories d'erreurs
- Statistiques par module
-
RAPPORT_CORRECTIONS_AUTO.md - Corrections automatiques
- Liste des corrections appliquées
- Résultats par catégorie
- Vérifications post-correction
-
VERIFICATION_LOGS.md - Vérification du système de logs
- Tests effectués
- Résultats de validation
Configuration et connexion
- CONNEXION.md - Guide de connexion
- Configuration Gitea
- Variables d'environnement
- Authentification
Tâches et planification
- TODO_IA_BATCH.md - Tâches modules IA et Batch
- Priorités de développement
- Améliorations prévues
- Statut des tâches
🚀 Par où commencer ?
Je découvre le projet
- Lisez le README principal pour une vue d'ensemble
- Consultez ARCHITECTURE.md pour comprendre la structure
- Parcourez MODULES.md pour voir les exemples de code
Je veux développer
- Installez les dépendances : voir README principal
- Configurez Ruff : GUIDE_RUFF.md
- Consultez les exemples dans MODULES.md
- Utilisez les utilitaires documentés dans ARCHITECTURE.md
Je veux comprendre le code existant
- Parcourez ARCHITECTURE.md pour le flux de données
- Consultez MODULES.md pour l'API de chaque module
- Lisez les docstrings Google-style dans le code source
Je veux améliorer la qualité
- Exécutez Ruff : voir GUIDE_RUFF.md
- Consultez les rapports : RAPPORT_RUFF.md
- Ajoutez des tests : voir structure dans ARCHITECTURE.md
📊 État du projet
Couverture de tests
- Globale : 16%
- Modules testés :
utils/gitea.py: 100% ✓utils/widgets.py: 100% ✓utils/logger.py: 94% ✓app/fiches/utils/tickets/core.py: 77% ✓utils/graph_utils.py: 59%
Qualité du code
- Linter : Ruff configuré avec 15 règles
- Style : Google docstrings
- Tests : 67 tests (100% passent)
🔗 Liens utiles
📝 Contribuer à la documentation
Pour améliorer la documentation :
- Architecture/Modules : Mettez à jour
ARCHITECTURE.mdouMODULES.md - Guides : Ajoutez un nouveau guide dans
docs/GUIDE_*.md - Rapports : Générez les rapports avec les commandes appropriées
- Exemples : Ajoutez des snippets dans
MODULES.md
Conventions :
- Utilisez le français pour le contenu
- Formatez le code avec des blocs markdown
- Ajoutez des émojis pour faciliter la navigation
- Maintenez la cohérence avec les documents existants
Dernière mise à jour : 7 février 2026