logml.report

Classes

ReportOutputStructure(*args, **kwargs)

Defines outputs structure for BaselineKit (+EDA) endpoint.

Exceptions

SkipTemplateRenderException

Raise the exception in case of View rendering-related issues.

exception logml.report.SkipTemplateRenderException

Bases: Exception

Raise the exception in case of View rendering-related issues.

class logml.report.ReportOutputStructure(*args, **kwargs)

Bases: logml.common.OutputStructure

Defines outputs structure for BaselineKit (+EDA) endpoint.

ROOT: str = 'report'

TEMPLATES: str = 'templates'

CUSTOM_TEMPLATES: str = 'custom_templates'

NOTEBOOKS: str = 'notebooks'

METADATA: str = 'metadata'

GENERATED_REPORT: str = ('_build', 'html')

BOOK_CFG = '_config.yml'

BOOK_TOC = '_toc.yml'

REPORT_INDEX = 'index.md'

REPORT_SOURCES = '_sources'

LOGO_FILENAME = 'logo.png'

JQUERY_FILE = 'jquery.js'

MJHJ_FILENAME = 'mathjax_hub_hijack.js'

STATIC_FOLDER = '_static'

property logo_file_path: pathlib.Path

Logo path.

property book_cfg_path: pathlib.Path

Returns a file with JupyterBook config.

property book_toc_path: pathlib.Path

Returns a file with JupyterBook TOC.

property report_index_path: pathlib.Path

Returns a file that is used as an index page for the report.

property rendered_report_path: pathlib.Path

Returns a folder with Baselinekit report rendered.

report_exists() → bool

Checks whether the result rendered report exists.

ignore_sources_folder_f(folder, _files) → List[str]

Filtering utility for rendered report files. ‘_sources’ folder is huge so we want to avoid adding it to the release.

Modules

logml.report.controllers
logml.report.notebooks
logml.report.notebooks_generation_runner
logml.report.packaging
logml.report.plotters
logml.report.report_runner
logml.report.resources
logml.report.toc_generation
logml.report.views