✨ add components to streamlit home site

- first section is home section recording it's compents
- needs to be treated separately

Author: enryH

src/vuegen/config_manager.py

@@ -301,12 +301,27 @@ def create_yamlconfig_fromdir(
         # Sort sections by their number prefix
         sorted_sections = self._sort_paths_by_numprefix(list(base_dir_path.iterdir()))
 
+        main_section_config = {
+            "title": self._create_title_fromdir("home_components"),
+            "description": "Components added to homepage.",
+            "components": [],
+        }
+        yaml_config["sections"].append(main_section_config)
+
         # Generate sections and subsections config
         for section_dir in sorted_sections:
             if section_dir.is_dir():
                 yaml_config["sections"].append(
                     self._create_sect_config_fromdir(section_dir)
                 )
+            # could be single plots?
+            else:
+                file_in_main_section_dir = section_dir
+                component_config = self._create_component_config_fromfile(
+                    file_in_main_section_dir
+                )
+                if component_config is not None:
+                    main_section_config["components"].append(component_config)
 
         return yaml_config, base_dir_path
 
@@ -372,6 +387,10 @@ def _create_section(self, section_data: dict) -> r.Section:
             description=section_data.get("description"),
         )
 
+        for component_data in section_data.get("components", []):
+            component = self._create_component(component_data)
+            section.components.append(component)
+
         # Create subsections
         for subsection_data in section_data.get("subsections", []):
             subsection = self._create_subsection(subsection_data)

src/vuegen/report.py

@@ -718,6 +718,7 @@ class Section:
     id: int = field(init=False)
     title: str
     subsections: List["Subsection"] = field(default_factory=list)
+    components: List["Component"] = field(default_factory=list)
     description: Optional[str] = None
 
     def __post_init__(self):

src/vuegen/streamlit_reportview.py

@@ -127,11 +127,14 @@ def generate_report(self, output_dir: str = SECTIONS_DIR) -> None:
             report_manag_content.append("\nsections_pages = {}")
 
             # Generate the home page and update the report manager content
+            # ! top level files (compontents) are added to the home page
             self._generate_home_section(
-                output_dir=output_dir, report_manag_content=report_manag_content
+                output_dir=output_dir,
+                report_manag_content=report_manag_content,
+                home_section=self.report.sections[0],
             )
 
-            for section in self.report.sections:
+            for section in self.report.sections[1:]:  # skip home section components
                 # Create a folder for each section
                 subsection_page_vars = []
                 section_name_var = section.title.replace(" ", "_")
@@ -293,7 +296,10 @@ def _format_text(
         return f"""st.markdown('''<{tag} style='text-align: {text_align}; color: {color};'>{text}</{tag}>''', unsafe_allow_html=True)"""
 
     def _generate_home_section(
-        self, output_dir: str, report_manag_content: list
+        self,
+        output_dir: str,
+        report_manag_content: list,
+        home_section: r.Section,
     ) -> None:
         """
         Generates the homepage for the report and updates the report manager content.
@@ -306,6 +312,13 @@ def _generate_home_section(
             A list to store the content that will be written to the report manager file.
         """
         self.report.logger.debug("Processing home section.")
+        all_components = []
+        subsection_imports = []
+        if home_section.components:
+            # some assert on title?
+            all_components, subsection_imports, _ = self._combine_components(
+                home_section.components
+            )
 
         try:
             # Create folder for the home page
@@ -320,6 +333,8 @@ def _generate_home_section(
             # Create the home page content
             home_content = []
             home_content.append(f"import streamlit as st")
+            if subsection_imports:
+                home_content.extend(subsection_imports)
             if self.report.description:
                 home_content.append(
                     self._format_text(text=self.report.description, type="paragraph")
@@ -329,6 +344,10 @@ def _generate_home_section(
                     f"\nst.image('{self.report.graphical_abstract}', use_column_width=True)"
                 )
 
+            # add components content to page (if any)
+            if all_components:
+                home_content.extend(all_components)
+
             # Define the footer variable and add it to the home page content
             home_content.append("footer = '''" + generate_footer() + "'''\n")
             home_content.append("st.markdown(footer, unsafe_allow_html=True)\n")
@@ -361,7 +380,7 @@ def _generate_sections(self, output_dir: str) -> None:
         self.report.logger.info("Starting to generate sections for the report.")
 
         try:
-            for section in self.report.sections:
+            for section in self.report.sections[1:]:
                 section_name_var = section.title.replace(" ", "_")
                 self.report.logger.debug(
                     f"Processing section '{section.id}': '{section.title}' - {len(section.subsections)} subsection(s)"