Code/utils/README.md
2025-05-11 15:47:54 +02:00

2.0 KiB

Module Utils

Ce module contient des utilitaires essentiels qui supportent le fonctionnement de l'application FabNum. Il fournit des fonctions génériques et des services partagés utilisés par les différents modules de l'application.

Structure du module

Le module utils comprend plusieurs fichiers utilitaires clés :

  • gitea.py : Fonctions pour interagir avec l'API Gitea (récupération des fiches, gestion des tickets, etc.)
  • graph_utils.py : Utilitaires pour manipuler, analyser et transformer les graphes de la chaîne de fabrication
  • visualisation.py : Fonctions communes pour la génération de visualisations et de graphiques

Fonctionnalités

Intégration Gitea (gitea.py)

  • Récupération des fiches et documents depuis le dépôt Gitea
  • Gestion de l'authentification et des tokens d'accès
  • Lecture et écriture des tickets et commentaires
  • Récupération des données de structure pour les fiches

Manipulation de graphes (graph_utils.py)

  • Chargement et sauvegarde des graphes de dépendance
  • Calcul des chemins critiques et des niveaux de criticité
  • Fonctions d'analyse pour identifier les vulnérabilités
  • Transformation et filtrage des graphes pour différentes analyses

Visualisation (visualisation.py)

  • Fonctions génériques pour générer des visualisations cohérentes
  • Helpers pour le formatage des données avant visualisation
  • Fonctions de conversion entre différents formats de données

Utilisation

Ce module est conçu pour être importé par les autres composants de l'application. Exemple d'utilisation :

from utils.gitea import charger_instructions_depuis_gitea
from utils.graph_utils import charger_graphe

# Chargement des instructions
instructions = charger_instructions_depuis_gitea(INSTRUCTIONS_PATH)

# Chargement du graphe principal
G_temp, G_temp_ivc, dot_file_path = charger_graphe()

Ce module est fondamental pour l'application car il centralise les fonctions réutilisables et réduit la duplication de code entre les différents composants de l'application.