Skip to content

Add HTML report CLI workflow#10

Merged
byemaxx merged 1 commit into
MetaX_V2from
report
May 10, 2026
Merged

Add HTML report CLI workflow#10
byemaxx merged 1 commit into
MetaX_V2from
report

Conversation

@byemaxx

@byemaxx byemaxx commented May 10, 2026

Copy link
Copy Markdown
Owner

This pull request introduces a new modular architecture for the metax.report package, adding robust configuration, CLI, registry, and path management systems, as well as new HTML templates for figure and plot rendering. The main themes are improved configurability, extensibility, and user interface enhancements for report generation.

Core Infrastructure and Configuration:

  • Added a comprehensive configuration system using dataclasses in config.py, supporting YAML import/export and detailed report, analysis, table, statistics, and plot options. This enables flexible and reproducible report setups.
  • Established a new CLI entrypoint in cli.py for generating reports, with argument parsing, config file support, and error handling, allowing command-line automation and integration.
  • Updated the __init__.py to set up a dedicated Matplotlib config directory and expose all major config and workflow classes at the package level, improving import ergonomics and reproducibility.

Report Output Management:

  • Introduced ReportPaths in paths.py to standardize and create all necessary output directories for tables, stats, figures, and logs, ensuring consistent file organization.
  • Added a ResultRegistry in registry.py to track generated tables, figures, stats, HTML, warnings, errors, and runtime metadata, with JSON serialization for downstream consumption or debugging.

User Interface and Templates:

  • Added new Jinja2 HTML templates for rendering figure tiles (figure_tile.html.j2) and a basic plots section (section_basic_plots.html.j2), providing a user-friendly, searchable, and interactive report interface for exploring generated outputs. [1] [2]

@byemaxx

byemaxx commented May 10, 2026

Copy link
Copy Markdown
Owner Author

@copilot review this merge

Copilot AI commented May 10, 2026

Copy link
Copy Markdown

@copilot review this merge

Reviewed at 8365cca. I validated the merge state by checking workflow runs and running the report test suite (tests/test_auto_report_config.py and tests/test_auto_report_workflow.py): all tests passed (6/6). I didn’t find any merge-related code issues that required additional changes.

@byemaxx byemaxx merged commit c88dfdf into MetaX_V2 May 10, 2026
1 check failed
Copilot stopped work on behalf of byemaxx due to an error May 10, 2026 15:46
@byemaxx byemaxx deleted the report branch June 13, 2026 02:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants