Merge branch 'main' into add_base_demo_to_docs

Author: sayalaruano

docs/vuegen_basic_case_study.ipynb

@@ -157,7 +157,7 @@
    "source": [
     "# Generate the report\n",
     "report_type = \"streamlit\"\n",
-    "report_generator.get_report(dir_path = base_output_dir, report_type = report_type, logger = get_logger(f\"{report_type}_report_basic_example\"))"
+    "report_generator.get_report(dir_path = base_output_dir, report_type = report_type, logger = None)"
    ]
   },
   {
@@ -190,7 +190,7 @@
    "source": [
     "# Generate the report\n",
     "report_type = \"html\"\n",
-    "report_generator.get_report(dir_path = base_output_dir, report_type = report_type, logger = get_logger(f\"{report_type}_report_basic_example\"))"
+    "report_generator.get_report(dir_path = base_output_dir, report_type = report_type, logger = None)"
    ]
   },
   {
@@ -246,7 +246,7 @@
     "for section in config[\"sections\"]:\n",
     "    if section[\"title\"] == \"Dataframes\":\n",
     "        for subsection in section[\"subsections\"]:\n",
-    "            if subsection[\"title\"] == \"All_formats\":\n",
+    "            if subsection[\"title\"] == \"All Formats\":\n",
     "                subsection[\"description\"] = \"This subsection contains example dataframes.\"\n"
    ]
   },
@@ -277,7 +277,7 @@
     "for section in config[\"sections\"]:\n",
     "    if section[\"title\"] == \"Plots\":\n",
     "        for subsection in section[\"subsections\"]:\n",
-    "            if subsection[\"title\"] == \"Static_plots\":\n",
+    "            if subsection[\"title\"] == \"Static Plots\":\n",
     "                subsection[\"components\"].append(vuegen_abst_fig)\n",
     "\n",
     "# Save the modified YAML file\n",
@@ -300,7 +300,7 @@
    "source": [
     "# Test the changes by generarating the report from the modified YAML file\n",
     "report_type = \"streamlit\"\n",
-    "report_generator.get_report(config_path = config_path, report_type = report_type, logger = get_logger(f\"{report_type}_report_basic_example_extended\"))"
+    "report_generator.get_report(config_path = config_path, report_type = report_type, logger = None)"
    ]
   },
   {
@@ -333,7 +333,7 @@
    "source": [
     "# Test the changes by generarating the report from the modified YAML file\n",
     "report_type = \"html\"\n",
-    "report_generator.get_report(config_path = config_path, report_type = report_type, logger = get_logger(f\"{report_type}_report_basic_example_extended\"))"
+    "report_generator.get_report(config_path = config_path, report_type = report_type, logger = None)"
    ]
   }
  ],

docs/vuegen_case_study_earth_microbiome.ipynb

@@ -1379,7 +1379,7 @@
    "source": [
     "# Generate the report\n",
     "report_type = \"streamlit\"\n",
-    "report_generator.get_report(dir_path = base_output_dir, report_type = report_type, logger = get_logger(f\"{report_type}_report_EMP_example\"))"
+    "report_generator.get_report(dir_path = base_output_dir, report_type = report_type, logger = None)"
    ]
   },
   {
@@ -1412,7 +1412,7 @@
    "source": [
     "# Generate the report\n",
     "report_type = \"html\"\n",
-    "report_generator.get_report(dir_path = base_output_dir, report_type = report_type, logger = get_logger(f\"{report_type}_report_EMP_example\"))"
+    "report_generator.get_report(dir_path = base_output_dir, report_type = report_type, logger = None)"
    ]
   },
   {
@@ -1558,7 +1558,7 @@
    "source": [
     "# Test the changes by generarating the report from the modified YAML file\n",
     "report_type = \"streamlit\"\n",
-    "report_generator.get_report(config_path = config_path, report_type = report_type, logger = get_logger(f\"{report_type}_report_EMP_example_extended\"))"
+    "report_generator.get_report(config_path = config_path, report_type = report_type, logger = None)"
    ]
   },
   {
@@ -1591,7 +1591,7 @@
    "source": [
     "# Test the changes by generarating the report from the modified YAML file\n",
     "report_type = \"html\"\n",
-    "report_generator.get_report(config_path = config_path, report_type = report_type, logger = get_logger(f\"{report_type}_report_EMP_example_extended\"))"
+    "report_generator.get_report(config_path = config_path, report_type = report_type, logger = None)"
    ]
   }
  ],

src/vuegen/report_generator.py

@@ -4,19 +4,19 @@
 from .quarto_reportview import QuartoReportView
 from .report import ReportType
 from .streamlit_reportview import StreamlitReportView
-from .utils import assert_enum_value, load_yaml_config, write_yaml_config
+from .utils import assert_enum_value, load_yaml_config, write_yaml_config, get_logger
 
 
-def get_report(report_type: str, logger: logging.Logger, config_path: str = None, dir_path: str = None, streamlit_autorun: bool = False) -> None:
+def get_report(report_type: str, logger: logging.Logger = get_logger("report"), config_path: str = None, dir_path: str = None, streamlit_autorun: bool = False) -> None:
     """
     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
-        A logger object to track warnings, errors, and info messages.
+    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
@@ -29,7 +29,7 @@ def get_report(report_type: str, logger: logging.Logger, config_path: str = None
     ValueError
         If neither 'config_path' nor 'directory' is provided.
     """
-    # Initialize the config manager object 
+    # Initialize the config manager object
     config_manager = ConfigManager(logger)
 
     if dir_path: