🖥️ html_renderer

Provides the ReportHTMLRenderer class, which is responsible for rendering HTML reports from structured data using Jinja2 templates.

Overview

This module provides the ReportHTMLRenderer class for rendering HTML reports from structured data using Jinja2 templates. It supports rendering from both Python dictionaries and JSON files, and saving the resulting HTML to disk.

Key Features

• Configurable template path for custom report layouts

• Rendering from in-memory data or JSON files

• Safe file output with directory creation

Typical usage example:

renderer = ReportHTMLRenderer()
html = renderer.render(report_data) # Render from a Python dictionary
html_from_json = renderer.render_from_json("report_data.json")  # Render from JSON file
renderer.save_html(html, output_path="outputs/report.html")

Classes

ReportHTMLRenderer

class owlmix.reporting.html_renderer.ReportHTMLRenderer(template_path: str | Path = DEFAULT_TEMPLATE_PATH)

Renders HTML reports from structured data using Jinja2 templates.

This class provides methods to render HTML from a Python dictionary or a JSON file, and to save the rendered HTML to disk. It is designed for use in automated EDA or analytics pipelines where reports need to be generated programmatically.

Parameters:

template_path (Optional[Union[str, Path]]) – Path to the directory containing Jinja2 templates. Defaults to the internal ‘_templates’ directory.

Methods

render(report_data: dict) → str

Render HTML from a dictionary of report data.

Parameters:

report_data (dict) – The report data to render. Should contain a “sections” key with section data.

Returns:

The rendered HTML as a string.

Return type:

str

render_from_json(json_path: str | Path) → str

Render HTML from a JSON file containing report data.

Parameters:

json_path (str or Path) – Path to the JSON file with report data.

Returns:

The rendered HTML as a string.

Return type:

str

save_html(html_str: str = None, output_path: str | Path = None)

Save the rendered HTML to a file.

Parameters:

• html_str (Optional[str]) – The HTML string to save. If None, uses the last rendered HTML.

• output_path (Optional[Union[str, Path]]) – The file path to save the HTML to.

Raises:

ValueError – If no HTML has been rendered or output_path is not specified.

html_str

Get the most recently rendered HTML string.

Returns:

The last rendered HTML string, or None if not rendered yet.

Return type:

Optional[str]

Module Attributes

owlmix.reporting.html_renderer.DEFAULT_TEMPLATE_PATH

Default path to the internal ‘_templates’ directory for Jinja2 templates.

owlmix.reporting.html_renderer.STATIC_PATH

Path to the internal ‘_static’ directory for Jinja2 static assets used in reports.

Back to Home