reporting-engine.toml: Reporting Engine

reporting-engine.toml

Configuration for the reporting engine.

Stores string references to the generator functions.

Copy-paste default configuration

Use this as a starting point in reporting-engine.toml.

generate_report_data = "orangeqs.juice.reporting.examples.generate_report_data"
get_aggregate_input_data = "orangeqs.juice.reporting.examples.get_aggregate_input_data"
template = "example_custom_template.md.jinja"

generate_report_data

Type: string. Default: 'orangeqs.juice.reporting.examples.generate_report_data'.

Dotted path to the function that generates report data.

get_aggregate_input_data

Type: string. Default: 'orangeqs.juice.reporting.examples.get_aggregate_input_data'.

Dotted path to the function that gets aggregate input data.

template

Type: string. Default: 'example_custom_template.md.jinja'.

The name of the template to use for rendering the report. The template should be located in either the default template directory (orangeqs.juice.reporting.templates) or in one of the extra template modules specified in extra_template_moduls.

extra_template_modules

Type: list[string].

List of extra python module directories to add to the templating environment. This is useful for adding custom templates. The modules should contain a ‘templates’ submodule with the templates in it. By default the following directories are added to the templating environment: - orangeqs.juice.reporting, module, - output directory specified specifiend while creating the report. Template directories will be searched in the order they are added, meaning that templates in directories added later will be searched before those in directories added earlier.

extra_filters

Type: list[string].

List of extra filters to add to the templating environment. The filters should be specified as dotted paths to the filter functions.