5.1 KiB
Documentation for odoo_extractor.py (2025-04-15 15:03:55)
User
peux tu me faire un .md pour documenter le fonctionnement de odoo_extractor.py avec des exemples
Assistant
Bien sûr ! Voici un exemple de contenu pour un fichier .md qui documente le fonctionnement de odoo_extractor.py, avec des exemples d'utilisation.
# 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.
## 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 :
python odoo_extractor.py --param1 valeur1 --param2 valeur2
Paramètres
--param1: Description du paramètre 1.--param2: Description du paramètre 2.
Exemples
Exemple 1 : Extraction de données de base
python odoo_extractor.py --param1 clients --param2 2023-01-01
Cet exemple extrait les données des clients à partir du 1er janvier 2023.
Exemple 2 : Extraction de données avec filtrage
python odoo_extractor.py --param1 commandes --param2 2023-01-01 --filter statut=livré
Cet exemple extrait les commandes livrées à partir du 1er janvier 2023.
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.
N'hésitez pas à adapter ce contenu selon les spécificités de votre script et les fonctionnalités qu'il offre. Si vous avez besoin d'autres sections ou d'informations supplémentaires, faites-le moi savoir !
---
_**User**_
il me faut des exemples plus explicites tu es trop généraliste voici le code du programme
---
_**Assistant**_
Merci pour les précisions. Voici une version mise à jour de la documentation pour `odoo_extractor.py`, avec des exemples plus explicites basés sur le code que vous avez fourni.
```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 :
python odoo_extractor.py --config config.json --verbose --output /chemin/vers/sortie
Paramètres
--configou-c: Fichier de configuration (par défautconfig.json).--verboseou-v: Active le mode verbeux pour plus de détails lors de l'exécution.--outputou-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 :
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 :
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 :
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 :
python odoo_extractor.py stages
Cette commande affichera toutes les étapes disponibles dans votre instance Odoo.
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.
N'hésitez pas à ajuster les exemples selon vos besoins spécifiques ou à demander d'autres modifications si nécessaire !
---
---