🐛 allow to specify log directory

Author: enryH

src/vuegen/__main__.py

@@ -36,8 +36,8 @@ def main():
     logger_suffix = f"{report_type}_report_{str(report_name)}"
 
     # Initialize logger
-    logger = get_logger(f"{logger_suffix}")
-
+    logger, logfile = get_logger(f"{logger_suffix}")
+    logger.info("logfile: %s", logfile)
     # Generate the report
     report_generator.get_report(
         report_type=report_type,

src/vuegen/config_manager.py

@@ -22,7 +22,9 @@ def __init__(self, logger: Optional[logging.Logger] = None):
         logger : logging.Logger, optional
             A logger instance for the class. If not provided, a default logger will be created.
         """
-        self.logger = logger or get_logger("report")
+        if logger is None:
+            logger, _ = get_logger("report")
+        self.logger = logger
 
     def _create_title_fromdir(self, file_dirname: str) -> str:
         """

src/vuegen/report_generator.py

@@ -15,6 +15,7 @@ def get_report(
     config_path: str = None,
     dir_path: str = None,
     streamlit_autorun: bool = False,
+    output_dir: Path = None,
 ) -> None:
     """
     Generate and run a report based on the specified engine.
@@ -37,9 +38,16 @@ def get_report(
     ValueError
         If neither 'config_path' nor 'directory' is provided.
     """
+    if output_dir is None:
+        output_dir = Path(".")
+    else:
+        output_dir = Path(output_dir)
     # Initialize logger only if it's not provided
     if logger is None:
-        logger = get_logger("report")
+        _folder = "logs"
+        if output_dir:
+            _folder = output_dir / _folder
+        logger, _ = get_logger("report", folder=_folder)
 
     # Create the config manager object
     config_manager = ConfigManager(logger)

src/vuegen/utils.py

@@ -635,9 +635,11 @@ def generate_log_filename(folder: str = "logs", suffix: str = "") -> str:
     str
         The file path to the log file
     """
-    # PRECONDITIONS
-    create_folder(folder)
-
+    try:
+        # PRECONDITIONS
+        create_folder(folder)  # ? Path(folder).mkdir(parents=True, exist_ok=True)
+    except OSError as e:
+        raise OSError(f"Error creating directory '{folder}': {e}")
     # MAIN FUNCTION
     log_filename = get_time(incl_timezone=False) + "_" + suffix + ".log"
     log_filepath = os.path.join(folder, log_filename)
@@ -703,7 +705,7 @@ def init_log(
     return logger
 
 
-def get_logger(log_suffix):
+def get_logger(log_suffix, folder="logs", display=True) -> tuple[logging.Logger, str]:
     """
     Initialize the logger with a log file name that includes an optional suffix.
 
@@ -714,19 +716,19 @@ def get_logger(log_suffix):
 
     Returns
     -------
-    logging.Logger
-        An initialized logger instance.
+    tuple[logging.Logger, str
+        A tuple containing the logger instance and the log file path.
     """
     # Generate log file name
-    log_file = generate_log_filename(suffix=log_suffix)
+    log_file = generate_log_filename(folder=folder, suffix=log_suffix)
 
     # Initialize logger
-    logger = init_log(log_file, display=True)
+    logger = init_log(log_file, display=display)
 
     # Log the path to the log file
     logger.info(f"Path to log file: {log_file}")
 
-    return logger
+    return logger, log_file
 
 
 def print_completion_message(report_type: str):