Report

Le module de reporting permet de créer des rapports au format ‘docx’ depuis des scripts Pyhton et/ou des Jupyter Notebooks.

Il est basé sur la librairie python-docx.

Le document finalement généré contient les éléments suivants:

• première page avec : titre, auteur, date de génération, nom de machine et utilisateur machine

• Table des matières (générée automatiquement sur base des titres)

• Liste numérotée des figures

Les éléments suivants peuvent être ajoutés au rapport:

• Titre avec niveaux

• Paragraphe

• Figure avec légende (numérotation automatique sur base de l’ordre d’introduction) à partir d’un fichier image, d’une image PIL, d’une Figure Matplotlib

• Liste à puces à partir d’une liste Python

• Tableau à partir d’une liste de listes, d’un DataFrame Pandas ou d’un dictionnaire

Warning

Il ne s’agit pas d’un outil de reporting complet avec des fonctionnalités avancées mais d’un moyen ‘simple’ de créer rapidement un rapport ‘à la volée’.

Par exemple : la numérotation des figures ne sera pas dynamique dans le fichier final.

from wolfhece.report.reporting import RapidReport

rapport = RapidReport('Rapport de script', 'Alice')

rapport.add_title('Titre Principal', level=0)
rapport.add_paragraph('Ceci est un **paragraphe** introductif avec des mots en *italique* et en **gras**.')

rapport += "Tentative d'ajout de figure vie un lien incorrect.\nPassage à la ligne"
rapport.add_figure('/path/to/image.png', 'Légende de la figure')

rapport.add_bullet_list(['Premier élément', 'Deuxième élément', 'Troisième élément'])

rapport.add_table_from_listoflists([['Nom', 'Âge'], ['Alice', '25'], ['Bob', '30']])

rapport.save('rapport.docx')