No default logger and print message after completion (#76)

* 🎨 Styile: print completion message in the terminal

* 🐛 Fix(report_generator.py): remove logger from the function definition to avoid creating a logger when there is not a report

* 🎨 Ensure black format

* 🎨 Black formsat on main

* 📝 Docs(pyproject.toml): update vuegen description

* 🎨 Style(pyproject.toml): description in a single line

Author: sayalaruano

pyproject.toml

@@ -3,7 +3,7 @@ name = "vuegen"
 dynamic = ["version"]
 
 [tool.poetry]
-description = "Module to generate automatic web interface reports with visualizations"
+description = "VueGen automates the creation of reports from bioinformatics outputs, supporting formats like PDF, HTML, DOCX, ODT, PPTX, Reveal.js, Jupyter notebooks, and Streamlit web applications. Users simply provide a directory with output files and VueGen compiles them into a structured report."
 authors = ["MoNA group"]
 license = "MIT"
 readme = "README.md"

src/vuegen/__main__.py

@@ -2,7 +2,7 @@
 from pathlib import Path
 
 from vuegen import report_generator
-from vuegen.utils import get_logger, get_parser
+from vuegen.utils import get_logger, get_parser, print_completion_message
 
 
 def main():
@@ -47,6 +47,9 @@ def main():
         streamlit_autorun=streamlit_autorun,
     )
 
+    # Print completion message
+    print_completion_message(report_type)
+
 
 if __name__ == "__main__":
     main()

src/vuegen/report_generator.py

@@ -10,7 +10,7 @@
 
 def get_report(
     report_type: str,
-    logger: logging.Logger = get_logger("report"),
+    logger: logging.Logger = None,
     config_path: str = None,
     dir_path: str = None,
     streamlit_autorun: bool = False,
@@ -36,7 +36,11 @@ def get_report(
     ValueError
         If neither 'config_path' nor 'directory' is provided.
     """
-    # Initialize the config manager object
+    # Initialize logger only if it's not provided
+    if logger is None:
+        logger = get_logger("report")
+
+    # Create the config manager object
     config_manager = ConfigManager(logger)
 
     if dir_path:

src/vuegen/utils.py

@@ -744,6 +744,46 @@ def get_logger(log_suffix):
     return logger
 
 
+def print_completion_message(report_type: str):
+    """
+    Prints a formatted completion message after report generation.
+    """
+    border = "─" * 65  # Creates a separator line
+    print(f"\n{border}\n🎉 Pipeline Execution Complete! 🎉\n")
+
+    if report_type == "streamlit":
+        print(
+            """🚀 Streamlit Report Generated!
+
+📂 All scripts to build the Streamlit app are available at:
+    nf_container_results/streamlit_report/sections
+
+▶️ To run the Streamlit app, use the following command:
+    streamlit run nf_container_results/streamlit_report/sections/report_manager.py
+
+✨ You can extend the report by adding new files to the input directory or updating the config file.
+
+🛠️ Advanced users can modify the Python scripts directly in:
+    nf_container_results/streamlit_report/sections
+"""
+        )
+    else:
+        print(
+            f"""🚀 {report_type.capitalize()} Report Generated!
+
+📂 Your {report_type} report is available at:
+    nf_container_results/quarto_report
+
+✨ You can extend the report by adding new files to the input directory or updating the config file.
+
+🛠️ Advanced users can modify the report template directly in:
+    nf_container_results/quarto_report/quarto_report.qmd
+"""
+        )
+
+    print(border)
+
+
 ## REPORT FORMATTING
 def generate_footer() -> str:
     """