mirror of
https://github.com/Ladebeze66/llm_ticket3.git
synced 2025-12-16 21:57:46 +01:00
83 lines
2.8 KiB
Markdown
83 lines
2.8 KiB
Markdown
# Documentation de odoo_extractor.py
|
|
|
|
## Introduction
|
|
|
|
`odoo_extractor.py` est un script Python conçu pour extraire des données de l'API Odoo. Ce document fournit une vue d'ensemble de son fonctionnement et des exemples d'utilisation détaillés.
|
|
|
|
## Installation
|
|
|
|
Avant d'exécuter le script, assurez-vous d'avoir installé les dépendances nécessaires. Vous pouvez le faire en utilisant pip :
|
|
|
|
```bash
|
|
pip install -r requirements.txt
|
|
```
|
|
|
|
## Utilisation
|
|
|
|
### Exécution du script
|
|
|
|
Pour exécuter le script, utilisez la commande suivante :
|
|
|
|
```bash
|
|
python odoo_extractor.py --config config.json --verbose --output /chemin/vers/sortie
|
|
```
|
|
|
|
### Paramètres
|
|
|
|
- `--config` ou `-c`: Fichier de configuration (par défaut `config.json`).
|
|
- `--verbose` ou `-v`: Active le mode verbeux pour plus de détails lors de l'exécution.
|
|
- `--output` ou `-o`: Répertoire de sortie pour les fichiers générés.
|
|
- `--no-md`: Désactive la génération automatique du fichier Markdown.
|
|
- `--extract-html-images`: Active l'extraction des images intégrées dans le HTML.
|
|
|
|
### Exemples
|
|
|
|
#### Exemple 1 : Extraction d'un ticket unique
|
|
|
|
Pour extraire un ticket unique par son code, utilisez la commande suivante :
|
|
|
|
```bash
|
|
python odoo_extractor.py ticket TICKET-123
|
|
```
|
|
|
|
Dans cet exemple, `TICKET-123` est le code du ticket que vous souhaitez extraire. Le script va récupérer les données de ce ticket et générer un rapport Markdown si l'option `--no-md` n'est pas spécifiée.
|
|
|
|
#### Exemple 2 : Extraction d'un lot de tickets
|
|
|
|
Pour extraire un lot de tickets avec des critères spécifiques, utilisez la commande suivante :
|
|
|
|
```bash
|
|
python odoo_extractor.py batch --domain "project_id:=1;stage_id:=2" --limit 10 --offset 0
|
|
```
|
|
|
|
Dans cet exemple :
|
|
- `--domain "project_id:=1;stage_id:=2"` : Cela signifie que vous souhaitez extraire des tickets qui appartiennent au projet avec l'ID 1 et qui sont dans l'étape avec l'ID 2.
|
|
- `--limit 10` : Limite le nombre de tickets extraits à 10.
|
|
- `--offset 0` : Commence l'extraction à partir du premier ticket.
|
|
|
|
#### Exemple 3 : Lister les projets disponibles
|
|
|
|
Pour lister tous les projets disponibles dans Odoo, utilisez la commande suivante :
|
|
|
|
```bash
|
|
python odoo_extractor.py projects
|
|
```
|
|
|
|
Cette commande affichera tous les projets disponibles dans votre instance Odoo.
|
|
|
|
#### Exemple 4 : Lister les étapes/statuts disponibles
|
|
|
|
Pour lister toutes les étapes ou statuts disponibles, utilisez la commande suivante :
|
|
|
|
```bash
|
|
python odoo_extractor.py stages
|
|
```
|
|
|
|
Cette commande affichera toutes les étapes disponibles dans votre instance Odoo.
|
|
|
|
Autre exemple d'extraction par lots:
|
|
python odoo_extractor.py batch --project 3 --stage 8 --limit 20
|
|
|
|
## Conclusion
|
|
|
|
`odoo_extractor.py` est un outil puissant pour interagir avec l'API Odoo et extraire des données pertinentes. Pour plus d'informations, consultez le code source et les commentaires dans le script. |