J6-8

README.md

@@ -1,13 +1,28 @@
-# Gestionnaire de Tickets Odoo Simplifié
+# Gestionnaire de Tickets Odoo
 
-Ce projet est une version simplifiée et optimisée du gestionnaire de tickets Odoo. Il permet d'interagir avec une instance Odoo pour gérer des tickets de projet.
+## Description
+Ce projet est un gestionnaire de tickets simplifié pour Odoo, permettant de gérer les tickets de manière efficace. Il inclut des fonctionnalités essentielles pour l'exportation, la recherche et l'extraction d'informations détaillées sur les tickets.
 
 ## Fonctionnalités
 
-1. **Afficher la liste des modèles** - Affiche tous les modèles disponibles dans l'instance Odoo.
-2. **Afficher les champs d'un modèle** - Affiche tous les champs d'un modèle donné.
-3. **Exporter les informations des champs en JSON** - Exporte la structure des champs d'un modèle en format JSON.
-4. **Exporter les tickets d'un project_id par étape** - Exporte tous les tickets d'un project_id, classés par étape (stage_id).
+1. **Exporter les tickets par projet et/ou étape** : 
+   - Permet d'exporter les tickets en fonction de critères de projet et d'étape, organisés dans des répertoires dédiés.
+
+2. **Rechercher un ticket par ID** : 
+   - Récupère les détails d'un ticket spécifique en utilisant son ID.
+
+3. **Rechercher un ticket par code** : 
+   - Permet de trouver un ticket en utilisant son code unique (ex: T102558).
+
+4. **Afficher la liste des modèles disponibles** : 
+   - Récupère et affiche tous les modèles disponibles dans Odoo.
+
+5. **Afficher les champs d'un modèle donné** : 
+   - Récupère et affiche les champs d'un modèle spécifique, en filtrant ceux qui ne sont pas exploitables.
+
+6. **Extraire les pièces jointes, messages et informations détaillées d'un ticket** : 
+   - Récupère toutes les pièces jointes, messages, activités et informations de contact associées à un ticket.
+   - Les informations sont sauvegardées dans des fichiers JSON organisés par ticket.
 
 ## Structure du projet
 
@@ -16,7 +31,7 @@ Ce projet est une version simplifiée et optimisée du gestionnaire de tickets O
 - `menu_handlers.py` - Gestionnaires d'actions pour chaque option du menu
 - `ticket_manager.py` - Classe principale pour la gestion des tickets et modèles
 - `odoo_connection.py` - Gestion de la connexion à l'instance Odoo
-- `data_filter.py` - Fonctions pour filtrer et nettoyer les données des tickets
+- `data_filter.py` - Fonctions pour filtrer et nettoyer les données des tickets //Retiré pour le moment
 - `utils.py` - Fonctions utilitaires diverses
 - `config.py` - Configuration de l'application (connexion Odoo, chemins d'export, etc.)
 
@@ -28,25 +43,24 @@ Ce projet est une version simplifiée et optimisée du gestionnaire de tickets O
 
 ## Installation
 
-1. Installer les dépendances :
-   ```
-   pip install odoorpc bs4
+1. Clonez le dépôt :
+   ```bash
+   git clone <URL_DU_DEPOT>
+   cd <NOM_DU_DOSSIER>
    ```
 
-2. Configurer les variables d'environnement (ou modifier `config.py`) :
-   - `ODOO_HOST` : Hôte de l'instance Odoo
-   - `ODOO_DB` : Nom de la base de données Odoo
-   - `ODOO_USER` : Nom d'utilisateur Odoo
-   - `ODOO_PASSWORD` : Mot de passe Odoo
+2. Installez les dépendances nécessaires (si applicable).
+
+3. Configurez votre connexion Odoo dans le fichier `config.py`.
 
 ## Utilisation
 
-1. Exécuter le programme :
-   ```
-   python main.py
-   ```
+Pour exécuter le gestionnaire de tickets, utilisez la commande suivante :
+```bash
+python main.py
+```
 
-2. Suivre les instructions du menu pour utiliser les différentes fonctionnalités.
+Suivez les instructions à l'écran pour naviguer dans le menu et utiliser les différentes fonctionnalités.
 
 ## Exemple d'utilisation
 
@@ -55,4 +69,12 @@ Ce projet est une version simplifiée et optimisée du gestionnaire de tickets O
 1. Sélectionner l'option 4 dans le menu
 2. Entrer l'ID du projet (par exemple, "5")
 3. Confirmer l'action
-4. Les tickets seront exportés dans le répertoire `exported_tickets/project_5_NomDuProjet/`, classés par étape 
+4. Les tickets seront exportés dans le répertoire `exported_tickets/project_5_NomDuProjet/`, classés par étape 
+
+## Contributions
+
+Les contributions sont les bienvenues ! N'hésitez pas à soumettre des demandes de tirage (pull requests) pour ajouter des fonctionnalités ou corriger des bogues.
+
+## License
+
+Ce projet est sous licence MIT. Voir le fichier `LICENSE` pour plus de détails.