Code/docs/CONNEXION.md
Stéphan Peccini f812fac89e
feat: Amelioration structure - tests, documentation et qualite du code
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>
2026-02-07 19:00:49 +01:00

46 lines
1.9 KiB
Markdown

# Authentification à FabNum avec un token Gitea
Ce document explique comment générer et utiliser un token d'accès personnel Gitea pour vous connecter à l'application FabNum.
## Caractéristiques du token requis
Pour pouvoir vous connecter à FabNum, votre token Gitea doit répondre aux critères suivants :
- Être associé à un compte utilisateur qui est membre de l'équipe **"Administrateurs"** dans l'organisation **"FabNum"**
- Disposer des permissions suffisantes pour :
- Accéder aux informations de l'utilisateur
- Lister les équipes d'une organisation
- Vérifier l'appartenance d'un utilisateur à une équipe
## Procédure pour générer un nouveau token
1. **Connectez-vous à Gitea** :
- Rendez-vous sur https://fabnum-git.peccini.fr et connectez-vous avec vos identifiants
2. **Accédez aux paramètres de votre profil** :
- Cliquez sur votre avatar en haut à droite
- Sélectionnez "Paramètres"
3. **Générez un nouveau token d'accès** :
- Dans le menu latéral gauche, cliquez sur "Applications"
- Faites défiler jusqu'à la section "Tokens d'accès personnel"
- Cliquez sur "Générer un nouveau token"
4. **Configurez le token** :
- Donnez un nom descriptif à votre token (par exemple "Token FabNum - Connexion")
- **Important** : Sélectionnez les autorisations suivantes au minimum :
- `read:user` - Accès en lecture pour les informations utilisateur
- `read:org` - Accès en lecture pour les organisations et équipes
5. **Générez et copiez le token** :
- Cliquez sur "Générer un token"
- **IMPORTANT** : Copiez immédiatement le token généré et conservez-le en lieu sûr. Gitea ne l'affichera plus jamais après cette étape.
## Utilisation du token
Une fois le token généré, utilisez-le pour vous connecter à l'application FabNum :
1. Accédez à l'application FabNum
2. Dans le formulaire d'authentification, collez votre token d'accès personnel Gitea
3. Cliquez sur "Se connecter"