vuegen.report_generator module

Contents

vuegen.report_generator module#

Main API entry point for generating reports using VueGen.

vuegen.report_generator.get_report(report_type: str, logger: Logger = None, config_path: str = None, dir_path: str = None, streamlit_autorun: bool = False, quarto_checks: bool = False, output_dir: Path = None, max_depth: int = 2) → tuple[str, str][source]#

Generate and run a report based on the specified engine.

Parameters:

  • report_type (str) – The report type. It should be one of the values of the ReportType Enum.

  • logger (logging.Logger, optional) – A logger object to track warnings, errors, and info messages. If not provided, a default logger will be created.

  • config_path (str, optional) – Path to the YAML configuration file.

  • dir_path (str, optional) – Path to the directory from which to generate the configuration file.

  • streamlit_autorun (bool, optional) – Whether to automatically run the Streamlit report after generation (default is False).

  • quarto_checks (bool, optional) – Whether to perform checks for Quarto report generation for TeX and Chromium installation (default is False).

  • output_dir (Path, optional) – The directory where the report folder will be generated. If not provided, the current directory will be used.

  • max_depth (int, optional) – The maximum depth of the directory structure to consider when generating the report. The default is 2, which means it will include sections and subsections. The parater is only used when ‘dir_path’ is used.

Raises:

ValueError – If neither ‘config_path’ nor ‘directory’ is provided.

Returns:

The path to the generated report and the path to the configuration file.

Return type:

tuple[str, str]

Contents