Skip to content

Notebook Report Maker

osa_tool.operations.analysis.notebook_report.report_maker

NotebookReportGenerator

Bases: AbstractReportGenerator

__init__(config_manager, git_agent, create_fork, notebook_paths=None)

Initialize PDF report generation for a repository's notebooks.

Parameters:

Name Type Description Default
config_manager ConfigManager

Provides repository configuration.

required
git_agent GitAgent

Supplies metadata, clone directory, and optional upload.

required
create_fork bool

Whether the generated report should be uploaded.

required
notebook_paths list[str] | None

Optional paths to limit analysis; an empty list scans the complete repository.

None

body_second_part()

Build detailed per-notebook PDF content after the summary page.

build_pdf()

Render the configured notebook analysis bundle to a PDF file.

Raises:

Type Description
RuntimeError

If ReportLab fails or no output file is produced.

run()

Analyze notebooks, build the PDF report, and return operation events.

table_generator()

Build summary tables rendered on the first PDF page.