auxi.core.reporting module¶
This module provides classes to create reports.
-
class
auxi.core.reporting.
Report
(data_source, output_path=None)¶ Bases:
auxi.core.objects.Object
Base class for all auxi reports.
-
render
(format=<ReportFormat.printout: (1, )>)¶ Render the report in the specified format
Parameters: format – The format. The default format is to print the report to the console. Returns: If the format was set to ‘string’ then a string representation of the report is returned.
-
-
class
auxi.core.reporting.
ReportFormat
¶ Bases:
enum.Enum
Represents the format the report should be outputted as.
-
csv
= <ReportFormat.csv: (4,)>¶
-
latex
= <ReportFormat.latex: (2,)>¶
-
matplotlib
= <ReportFormat.matplotlib: (6,)>¶
-
png
= <ReportFormat.png: 7>¶
-
printout
= <ReportFormat.printout: (1,)>¶
-
string
= <ReportFormat.string: (5,)>¶
-
txt
= <ReportFormat.txt: (3,)>¶
-