Load home image on the base folder when creating a report from a directory (#152)

* ✨ Add code to look for a home image on the base folder and load it if exist when creating a report from a directory

A Enum for ImageFormats was also created on the report.py script

* 🐛 Fix: make comment line shorter to follow convention

* ✅ Update test report files with the home image addition

* Trigger GitHub Actions

* Re-trigger GitHub Actions bc of tynitex issue

Author: sayalaruano

docs/example_data/Basic_example_vuegen_demo_notebook/home_image.png

@@ -215,6 +215,28 @@ def _read_description_file(self, folder_path: Path) -> str:
             return f"{ret}\n"
         return ""
 
+    def _read_home_image_file(self, folder_path: Path) -> str:
+        """
+        Looks for an image file named 'home_image' with any supported image extension
+        in the given folder.
+
+        Parameters
+        ----------
+        folder_path : Path
+            Path to the folder where the 'home_image' file might be located.
+
+        Returns
+        -------
+        str
+            Path to the 'home_image' image file as a string if found, otherwise an
+            empty string.
+        """
+        for image_format in r.ImageFormat:
+            candidate = folder_path / f"home_image{image_format.value_with_dot}"
+            if candidate.exists() and candidate.is_file():
+                return str(candidate)
+        return ""
+
     def _create_subsect_config_fromdir(
         self, subsection_dir_path: Path, level: int = 2
     ) -> Dict[str, Union[str, List[Dict]]]:
@@ -334,7 +356,7 @@ def create_yamlconfig_fromdir(
                 # This will be used for the home section of a report
                 "title": self._create_title_fromdir(base_dir_path.name),
                 "description": self._read_description_file(base_dir_path),
-                "graphical_abstract": "",
+                "graphical_abstract": self._read_home_image_file(base_dir_path),
                 "logo": "",
             },
             "sections": [],
@@ -358,8 +380,11 @@ def create_yamlconfig_fromdir(
             # could be single plots?
             else:
                 file_in_main_section_dir = section_dir
-                if file_in_main_section_dir.name.lower() == "description.md":
-                    continue  # Skip description files in the main section
+                if (
+                    file_in_main_section_dir.name.lower() == "description.md"
+                    or "home_image" in file_in_main_section_dir.name.lower()
+                ):
+                    continue  # Skip description file and home_image in the main section
                 component_config = self._create_component_config_fromfile(
                     file_in_main_section_dir
                 )

src/vuegen/config_manager.py

@@ -100,6 +100,22 @@ def value_with_dot(self):
         return f".{self.name.lower()}"
 
 
+class ImageFormat(StrEnum):
+    """Enum representing supported image file formats."""
+
+    PNG = auto()
+    JPG = auto()
+    JPEG = auto()
+    SVG = auto()
+    GIF = auto()
+    WEBP = auto()
+
+    @property
+    def value_with_dot(self):
+        """Return the file extension with the dot."""
+        return f".{self.name.lower()}"
+
+
 @dataclass
 class Component:
     """

src/vuegen/report.py

@@ -27,6 +27,8 @@ report_dir = Path().cwd()
 
 A general description of the report.
 
+![](../../../../../docs/example_data/Basic_example_vuegen_demo_notebook/home_image.png){fig-alt= width=90%}
+
 # Plots
 ## Interactive Plots
 Optional description for section.

tests/report_examples/Basic_example_vuegen_demo_notebook/docx/quarto_report/quarto_report.qmd

@@ -53,6 +53,8 @@ report_dir = Path().cwd()
 
 A general description of the report.
 
+![](../../../../../docs/example_data/Basic_example_vuegen_demo_notebook/home_image.png){fig-alt= width=90%}
+
 # Plots
 ## Interactive Plots
 Optional description for section.

tests/report_examples/Basic_example_vuegen_demo_notebook/html/quarto_report/quarto_report.qmd

@@ -53,6 +53,8 @@ report_dir = Path().cwd()
 
 A general description of the report.
 
+![](../../../../../docs/example_data/Basic_example_vuegen_demo_notebook/home_image.png){fig-alt= width=90%}
+
 # Plots
 ## Interactive Plots
 Optional description for section.

tests/report_examples/Basic_example_vuegen_demo_notebook/jupyter/quarto_report/quarto_report.qmd

@@ -27,6 +27,8 @@ report_dir = Path().cwd()
 
 A general description of the report.
 
+![](../../../../../docs/example_data/Basic_example_vuegen_demo_notebook/home_image.png){fig-alt= width=90%}
+
 # Plots
 ## Interactive Plots
 Optional description for section.

tests/report_examples/Basic_example_vuegen_demo_notebook/odt/quarto_report/quarto_report.qmd

@@ -39,6 +39,8 @@ report_dir = Path().cwd()
 
 A general description of the report.
 
+![](../../../../../docs/example_data/Basic_example_vuegen_demo_notebook/home_image.png){fig-alt= width=90%}
+
 # Plots
 ## Interactive Plots
 Optional description for section.

tests/report_examples/Basic_example_vuegen_demo_notebook/pdf/quarto_report/quarto_report.qmd

@@ -28,6 +28,8 @@ report_dir = Path().cwd()
 
 A general description of the report.
 
+![](../../../../../docs/example_data/Basic_example_vuegen_demo_notebook/home_image.png){fig-alt= width=90%}
+
 # Plots
 ## Interactive Plots
 Optional description for section.

tests/report_examples/Basic_example_vuegen_demo_notebook/pptx/quarto_report/quarto_report.qmd

@@ -54,6 +54,8 @@ report_dir = Path().cwd()
 
 A general description of the report.
 
+![](../../../../../docs/example_data/Basic_example_vuegen_demo_notebook/home_image.png){fig-alt= width=90%}
+
 # Plots
 ## Interactive Plots
 Optional description for section.