chore: Move logger setup to CLI in readme generator

- Also just create logger instances in the modules themselves rather
  than using a shared one in constants.py

Signed-off-by: Giulio Frasca <[email protected]>

Author: gmfrasca

scripts/generate_readme/cli.py

@@ -4,7 +4,8 @@
 import logging
 from pathlib import Path
 
-from .constants import logger
+logger = logging.getLogger(__name__)
+
 from .writer import ReadmeWriter
 
 
@@ -130,12 +131,18 @@ def main():
     # Parse arguments
     args = parse_arguments()
 
+    # Configure logging at application entry point
+    log_level = logging.DEBUG if args.verbose else logging.INFO
+    logging.basicConfig(
+        level=log_level,
+        format='%(levelname)s: %(message)s'
+    )
+
     # Create and run the README writer
     writer = ReadmeWriter(
         component_dir=args.component,
         pipeline_dir=args.pipeline,
         output_file=args.output,
-        verbose=args.verbose,
         overwrite=args.overwrite
     )
     writer.generate()

scripts/generate_readme/constants.py

@@ -1,9 +1,4 @@
 """Constants and shared configuration for the generate_readme package."""
 
-import logging
-
-# Set up logger
-logger = logging.getLogger(__name__)
-
 # Custom content marker for preserving user-added content
 CUSTOM_CONTENT_MARKER = '<!-- custom-content -->'

scripts/generate_readme/content_generator.py

@@ -1,11 +1,13 @@
 """README content generator for KFP components and pipelines."""
 
+import logging
 import re
 from pathlib import Path
 from typing import Any, Dict
 import yaml
 from jinja2 import Environment, FileSystemLoader
-from .constants import logger
+
+logger = logging.getLogger(__name__)
 
 
 class ReadmeContentGenerator:

scripts/generate_readme/metadata_parser.py

@@ -6,12 +6,13 @@
 """
 
 import ast
+import logging
 from pathlib import Path
 from typing import Any, Dict, Optional, Union
 
 from docstring_parser import parse as parse_docstring
 
-from .constants import logger
+logger = logging.getLogger(__name__)
 
 
 class MetadataParser:

scripts/generate_readme/tests/test_constants.py

@@ -13,7 +13,6 @@ def test_init_with_component(self, component_dir):
         """Test initialization with component directory."""
         generator = ReadmeWriter(
             component_dir=component_dir,
-            verbose=False,
             overwrite=True
         )
 
@@ -26,7 +25,6 @@ def test_init_with_pipeline(self, pipeline_dir):
         """Test initialization with pipeline directory."""
         generator = ReadmeWriter(
             pipeline_dir=pipeline_dir,
-            verbose=False,
             overwrite=True
         )
 
@@ -170,15 +168,15 @@ def test_custom_output_file(self, component_dir, temp_dir):
         content = custom_output.read_text()
         assert "# Sample Component" in content
 
-    def test_generate_with_verbose(self, component_dir, caplog):
-        """Test that verbose mode produces debug output."""
+    def test_generate_with_debug_logging(self, component_dir, caplog):
+        """Test that debug messages are logged when debug level is set."""
         import logging
 
+        # Set debug level (normally done by CLI)
         caplog.set_level(logging.DEBUG)
 
         generator = ReadmeWriter(
             component_dir=component_dir,
-            verbose=True,
             overwrite=True
         )
         generator.generate()

scripts/generate_readme/tests/test_writer.py

@@ -5,23 +5,24 @@
 from pathlib import Path
 from typing import Optional
 
-from .constants import CUSTOM_CONTENT_MARKER, logger
+from .constants import CUSTOM_CONTENT_MARKER
 from .content_generator import ReadmeContentGenerator
 from .metadata_parser import MetadataParser
 
+logger = logging.getLogger(__name__)
+
 
 class ReadmeWriter:
     """Writes README documentation for Kubeflow Pipelines components and pipelines."""
 
     def __init__(self, component_dir: Optional[Path] = None, pipeline_dir: Optional[Path] = None,
-                 output_file: Optional[Path] = None, verbose: bool = False, overwrite: bool = False):
+                 output_file: Optional[Path] = None, overwrite: bool = False):
         """Initialize the README writer.
 
         Args:
             component_dir: Path to the component directory (must contain component.py and metadata.yaml).
             pipeline_dir: Path to the pipeline directory (must contain pipeline.py and metadata.yaml).
             output_file: Optional output path for the generated README.
-            verbose: Enable verbose logging output.
             overwrite: Overwrite existing README without prompting.
         """
         # Validate that exactly one of component_dir or pipeline_dir is provided
@@ -46,20 +47,8 @@ def __init__(self, component_dir: Optional[Path] = None, pipeline_dir: Optional[
         self.parser = MetadataParser(self.source_file, self.function_type)
         self.metadata_file = self.source_dir / 'metadata.yaml'
         self.readme_file = output_file if output_file else self.source_dir / "README.md"
-        self.verbose = verbose
         self.overwrite = overwrite
 
-        # Configure logging
-        self._configure_logging()
-
-    def _configure_logging(self) -> None:
-        """Configure logging based on verbose flag."""
-        log_level = logging.DEBUG if self.verbose else logging.INFO
-        logging.basicConfig(
-            level=log_level,
-            format='%(levelname)s: %(message)s'
-        )
-
     def _extract_custom_content(self) -> Optional[str]:
         """Extract custom content from existing README if it has a custom-content marker.