🎨 streamlit footer in utils? use central constants for footer, dedent

enryH · enryH · commit 37eceb03d19f · 2025-06-26T15:01:56.000+02:00
diff --git a/src/vuegen/utils/__init__.py b/src/vuegen/utils/__init__.py
@@ -5,25 +5,27 @@
 import logging
 import os
 import sys
+import textwrap
 from datetime import datetime
-
-try:
-    from enum import StrEnum
-except ImportError:
-    from strenum import StrEnum
-
 from io import StringIO
 from pathlib import Path
-from typing import Iterable, Type
+from typing import Iterable, Optional, Type
 from urllib.parse import urlparse
 
 import networkx as nx
 import requests
 import yaml
 from bs4 import BeautifulSoup
 
+try:
+    from enum import StrEnum
+except ImportError:
+    from strenum import StrEnum
 
-## CHECKS
+from vuegen.constants import GITHUB_ORG_URL, LOGO_URL, ORG, REPO_URL, TIMEOUT
+
+
+# CHECKS
 def check_path(filepath: Path) -> bool:
     """
     Checks if the given file or folder path exists.
@@ -848,7 +850,8 @@ def get_completion_message(report_type: str, config_path: str) -> str:
     return f"{message}\n{border}"
 
 
-## REPORT FORMATTING
+# REPORT FORMATTING
+# ? move as only used in streamlit_report
 def generate_footer() -> str:
     """
     Generate an HTML footer for a report.
@@ -861,23 +864,27 @@ def generate_footer() -> str:
     str
         A formatted HTML string representing the footer.
     """
-    footer = """<style type="text/css">
-.footer {
-    position: relative;
-    left: 0;
-    width: 100%;
-    text-align: center;
-}
-</style>
-<footer class="footer">
-    This report was generated with
-    <a href="https://github.com/Multiomics-Analytics-Group/vuegen" target="_blank">
-        <img src="https://raw.githubusercontent.com/Multiomics-Analytics-Group/vuegen/main/docs/images/vuegen_logo.svg" alt="VueGen" width="65px">
-    </a>
-    | Copyright 2025 <a href="https://github.com/Multiomics-Analytics-Group" target="_blank">
-        Multiomics Network Analytics Group (MoNA)
-    </a>
-</footer>"""
+    footer = textwrap.dedent(
+        f"""
+        <style type="text/css">
+        .footer \u007b
+            position: relative;
+            left: 0;
+            width: 100%;
+            text-align: center;
+        \u007d
+        </style>
+        <footer class="footer">
+            This report was generated with
+            <a href="{REPO_URL}" target="_blank">
+                <img src="{LOGO_URL}" alt="VueGen" width="65px">
+            </a>
+            | Copyright 2025 <a href="{GITHUB_ORG_URL}" target="_blank">
+                {ORG}
+            </a>
+        </footer>
+        """
+    )
     return footer
 
 
diff --git a/tests/report_examples/Basic_example_vuegen_demo_notebook/streamlit_report/sections/Dataframes/All_Formats.py b/tests/report_examples/Basic_example_vuegen_demo_notebook/streamlit_report/sections/Dataframes/All_Formats.py
@@ -204,7 +204,8 @@
     mime='text/csv',
     key=f"download_button_{df_index}")
 df_index += 1
-footer = '''<style type="text/css">
+footer = '''
+<style type="text/css">
 .footer {
     position: relative;
     left: 0;
@@ -220,6 +221,7 @@
     | Copyright 2025 <a href="https://github.com/Multiomics-Analytics-Group" target="_blank">
         Multiomics Network Analytics Group (MoNA)
     </a>
-</footer>'''
+</footer>
+'''
 
 st.markdown(footer, unsafe_allow_html=True)
diff --git a/tests/report_examples/Basic_example_vuegen_demo_notebook/streamlit_report/sections/Home/Homepage.py b/tests/report_examples/Basic_example_vuegen_demo_notebook/streamlit_report/sections/Home/Homepage.py
@@ -7,7 +7,8 @@
     ),
     unsafe_allow_html=True)
 
-footer = '''<style type="text/css">
+footer = '''
+<style type="text/css">
 .footer {
     position: relative;
     left: 0;
@@ -23,6 +24,7 @@
     | Copyright 2025 <a href="https://github.com/Multiomics-Analytics-Group" target="_blank">
         Multiomics Network Analytics Group (MoNA)
     </a>
-</footer>'''
+</footer>
+'''
 
 st.markdown(footer, unsafe_allow_html=True)
diff --git a/tests/report_examples/Basic_example_vuegen_demo_notebook/streamlit_report/sections/Html/All_Html.py b/tests/report_examples/Basic_example_vuegen_demo_notebook/streamlit_report/sections/Html/All_Html.py
@@ -63,7 +63,8 @@
 
 st.components.v1.html(html_content, height=600, scrolling=True)
 
-footer = '''<style type="text/css">
+footer = '''
+<style type="text/css">
 .footer {
     position: relative;
     left: 0;
@@ -79,6 +80,7 @@
     | Copyright 2025 <a href="https://github.com/Multiomics-Analytics-Group" target="_blank">
         Multiomics Network Analytics Group (MoNA)
     </a>
-</footer>'''
+</footer>
+'''
 
 st.markdown(footer, unsafe_allow_html=True)
diff --git a/tests/report_examples/Basic_example_vuegen_demo_notebook/streamlit_report/sections/Markdown/All_Markdown.py b/tests/report_examples/Basic_example_vuegen_demo_notebook/streamlit_report/sections/Markdown/All_Markdown.py
@@ -23,7 +23,8 @@
 
 st.markdown(markdown_content, unsafe_allow_html=True)
 
-footer = '''<style type="text/css">
+footer = '''
+<style type="text/css">
 .footer {
     position: relative;
     left: 0;
@@ -39,6 +40,7 @@
     | Copyright 2025 <a href="https://github.com/Multiomics-Analytics-Group" target="_blank">
         Multiomics Network Analytics Group (MoNA)
     </a>
-</footer>'''
+</footer>
+'''
 
 st.markdown(footer, unsafe_allow_html=True)
diff --git a/tests/report_examples/Basic_example_vuegen_demo_notebook/streamlit_report/sections/Networks/Interactive_Networks.py b/tests/report_examples/Basic_example_vuegen_demo_notebook/streamlit_report/sections/Networks/Interactive_Networks.py
@@ -57,7 +57,8 @@
 
 st.markdown(markdown_content, unsafe_allow_html=True)
 
-footer = '''<style type="text/css">
+footer = '''
+<style type="text/css">
 .footer {
     position: relative;
     left: 0;
@@ -73,6 +74,7 @@
     | Copyright 2025 <a href="https://github.com/Multiomics-Analytics-Group" target="_blank">
         Multiomics Network Analytics Group (MoNA)
     </a>
-</footer>'''
+</footer>
+'''
 
 st.markdown(footer, unsafe_allow_html=True)
diff --git a/tests/report_examples/Basic_example_vuegen_demo_notebook/streamlit_report/sections/Networks/Static_Networks.py b/tests/report_examples/Basic_example_vuegen_demo_notebook/streamlit_report/sections/Networks/Static_Networks.py
@@ -19,7 +19,8 @@
 
 st.image('docs/example_data/Basic_example_vuegen_demo_notebook/3_Networks/2_Static_networks/1_phyla_correlation_network.png',  caption='', use_column_width=True)
 
-footer = '''<style type="text/css">
+footer = '''
+<style type="text/css">
 .footer {
     position: relative;
     left: 0;
@@ -35,6 +36,7 @@
     | Copyright 2025 <a href="https://github.com/Multiomics-Analytics-Group" target="_blank">
         Multiomics Network Analytics Group (MoNA)
     </a>
-</footer>'''
+</footer>
+'''
 
 st.markdown(footer, unsafe_allow_html=True)
diff --git a/tests/report_examples/Basic_example_vuegen_demo_notebook/streamlit_report/sections/Plots/Interactive_Plots.py b/tests/report_examples/Basic_example_vuegen_demo_notebook/streamlit_report/sections/Plots/Interactive_Plots.py
@@ -149,7 +149,8 @@
 
 st.markdown(markdown_content, unsafe_allow_html=True)
 
-footer = '''<style type="text/css">
+footer = '''
+<style type="text/css">
 .footer {
     position: relative;
     left: 0;
@@ -165,6 +166,7 @@
     | Copyright 2025 <a href="https://github.com/Multiomics-Analytics-Group" target="_blank">
         Multiomics Network Analytics Group (MoNA)
     </a>
-</footer>'''
+</footer>
+'''
 
 st.markdown(footer, unsafe_allow_html=True)
diff --git a/tests/report_examples/Basic_example_vuegen_demo_notebook/streamlit_report/sections/Plots/Static_Plots.py b/tests/report_examples/Basic_example_vuegen_demo_notebook/streamlit_report/sections/Plots/Static_Plots.py
@@ -41,7 +41,8 @@
 
 st.image('docs/example_data/Basic_example_vuegen_demo_notebook/1_Plots/2_Static_plots/3_alpha_diversity_host_associated_samples.png',  caption='', use_column_width=True)
 
-footer = '''<style type="text/css">
+footer = '''
+<style type="text/css">
 .footer {
     position: relative;
     left: 0;
@@ -57,6 +58,7 @@
     | Copyright 2025 <a href="https://github.com/Multiomics-Analytics-Group" target="_blank">
         Multiomics Network Analytics Group (MoNA)
     </a>
-</footer>'''
+</footer>
+'''
 
 st.markdown(footer, unsafe_allow_html=True)
