config-cli-gui 0.2.0__tar.gz → 0.2.2__tar.gz

{config_cli_gui-0.2.0 → config_cli_gui-0.2.2}/.idea/runConfigurations/config_generate.xml

@@ -8,16 +8,16 @@
       <env name="PYTHONUNBUFFERED" value="1" />
     </envs>
     <option name="SDK_HOME" value="" />
-    <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$/tests/example_project/config" />
+    <option name="WORKING_DIRECTORY" value="$ProjectFileDir$" />
     <option name="IS_MODULE_SDK" value="true" />
     <option name="ADD_CONTENT_ROOTS" value="true" />
     <option name="ADD_SOURCE_ROOTS" value="true" />
     <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
-    <option name="SCRIPT_NAME" value="$PROJECT_DIR$/tests/example_project/config/config_example.py" />
+    <option name="SCRIPT_NAME" value="example_project.config.config_example" />
     <option name="PARAMETERS" value="" />
     <option name="SHOW_COMMAND_LINE" value="false" />
     <option name="EMULATE_TERMINAL" value="false" />
-    <option name="MODULE_MODE" value="false" />
+    <option name="MODULE_MODE" value="true" />
     <option name="REDIRECT_INPUT" value="false" />
     <option name="INPUT_FILE" value="" />
     <method v="2" />

config_cli_gui-0.2.2/.idea/runConfigurations/example_project_cli.xml

@@ -0,0 +1,24 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="example_project.cli" type="PythonConfigurationType" factoryName="Python">
+    <module name="config-cli-gui" />
+    <option name="ENV_FILES" value="" />
+    <option name="INTERPRETER_OPTIONS" value="" />
+    <option name="PARENT_ENVS" value="true" />
+    <envs>
+      <env name="PYTHONUNBUFFERED" value="1" />
+    </envs>
+    <option name="SDK_HOME" value="" />
+    <option name="WORKING_DIRECTORY" value="$ProjectFileDir$" />
+    <option name="IS_MODULE_SDK" value="true" />
+    <option name="ADD_CONTENT_ROOTS" value="true" />
+    <option name="ADD_SOURCE_ROOTS" value="true" />
+    <option name="SCRIPT_NAME" value="example_project.cli" />
+    <option name="PARAMETERS" value="--elevation --min_dist 77 --output outputfile.gpx tests/example_project/example.gpx" />
+    <option name="SHOW_COMMAND_LINE" value="false" />
+    <option name="EMULATE_TERMINAL" value="false" />
+    <option name="MODULE_MODE" value="true" />
+    <option name="REDIRECT_INPUT" value="false" />
+    <option name="INPUT_FILE" value="" />
+    <method v="2" />
+  </configuration>
+</component>

config_cli_gui-0.2.2/.idea/runConfigurations/example_project_gui.xml

@@ -0,0 +1,24 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="example_project.gui" type="PythonConfigurationType" factoryName="Python" nameIsGenerated="true">
+    <module name="config-cli-gui" />
+    <option name="ENV_FILES" value="" />
+    <option name="INTERPRETER_OPTIONS" value="" />
+    <option name="PARENT_ENVS" value="true" />
+    <envs>
+      <env name="PYTHONUNBUFFERED" value="1" />
+    </envs>
+    <option name="SDK_HOME" value="" />
+    <option name="WORKING_DIRECTORY" value="$ProjectFileDir$" />
+    <option name="IS_MODULE_SDK" value="true" />
+    <option name="ADD_CONTENT_ROOTS" value="true" />
+    <option name="ADD_SOURCE_ROOTS" value="true" />
+    <option name="SCRIPT_NAME" value="example_project.gui" />
+    <option name="PARAMETERS" value="" />
+    <option name="SHOW_COMMAND_LINE" value="false" />
+    <option name="EMULATE_TERMINAL" value="false" />
+    <option name="MODULE_MODE" value="true" />
+    <option name="REDIRECT_INPUT" value="false" />
+    <option name="INPUT_FILE" value="" />
+    <method v="2" />
+  </configuration>
+</component>

{config_cli_gui-0.2.0 → config_cli_gui-0.2.2}/HISTORY.md

@@ -4,6 +4,20 @@ Changelog
 
 (unreleased)
 ------------
+- #9 cli: unittests. [Paul Magister]
+
+
+0.2.1 (2025-11-14)
+------------------
+- #9 Fix cli bugs: allow toggle or bool. [Paul Magister]
+- #9 Fix cli bugs. [Paul Magister]
+- #9 Fix problems and add ide configs. [Paul Magister]
+- #9 fix cli_example.py. [Paul Magister]
+
+
+0.2.0 (2025-11-13)
+------------------
+- Docs: Update HISTORY.md for release 0.2.0. [Paul Magister]
 - #9 fix posix path issue. [Paul Magister]
 - #9 fix posix path issue. [Paul Magister]
 

{config_cli_gui-0.2.0 → config_cli_gui-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: config-cli-gui
-Version: 0.2.0
+Version: 0.2.2
 Summary: Feature-rich Python project template for config-cli-gui.
 Author: pamagister
 Requires-Python: <3.12,>=3.10

{config_cli_gui-0.2.0 → config_cli_gui-0.2.2}/config.yaml

@@ -42,7 +42,7 @@ gui:
 misc:
   # Color setting for the application | type=Color, default=#ff0000
   some_color: '#ff0000'
-  # Date setting for the application | type=datetime, default=2025-11-13 22:49:38.801511
-  some_date: '2025-11-13T22:49:38.801511'
+  # Date setting for the application | type=datetime, default=2025-12-31 10:30:45
+  some_date: '2025-12-31T10:30:45'
   # Path to the file to use | type=PosixPath, default=some_file.txt
   some_file: some_file.txt

{config_cli_gui-0.2.0 → config_cli_gui-0.2.2}/docs/usage/config.md

@@ -39,9 +39,9 @@ The parameters in the cli category can be accessed via the command line interfac
 
 ## Category "misc"
 
-| Name       | Type      | Description                       | Default                                             | Choices |
-|------------|-----------|-----------------------------------|-----------------------------------------------------|---------|
-| some_file  | PosixPath | Path to the file to use           | PosixPath('some_file.txt')                          | -       |
-| some_color | Color     | Color setting for the application | Color(255, 0, 0)                                    | -       |
-| some_date  | datetime  | Date setting for the application  | datetime.datetime(2025, 11, 13, 22, 49, 38, 801511) | -       |
+| Name       | Type      | Description                       | Default                                     | Choices |
+|------------|-----------|-----------------------------------|---------------------------------------------|---------|
+| some_file  | PosixPath | Path to the file to use           | PosixPath('some_file.txt')                  | -       |
+| some_color | Color     | Color setting for the application | Color(255, 0, 0)                            | -       |
+| some_date  | datetime  | Date setting for the application  | datetime.datetime(2025, 12, 31, 10, 30, 45) | -       |
 

{config_cli_gui-0.2.0 → config_cli_gui-0.2.2}/src/config_cli_gui/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.2.0'
-__version_tuple__ = version_tuple = (0, 2, 0)
+__version__ = version = '0.2.2'
+__version_tuple__ = version_tuple = (0, 2, 2)
 
-__commit_id__ = commit_id = 'gd5e29e239'
+__commit_id__ = commit_id = 'g965db4933'

config_cli_gui-0.2.2/src/config_cli_gui/cli.py

@@ -0,0 +1,147 @@
+# config_cli_gui/cli_example.py
+"""Generic CLI generator for configuration framework."""
+
+import argparse
+import traceback
+from collections.abc import Callable
+from typing import Any
+
+from config_cli_gui.config import ConfigManager
+
+
+def str2bool(v: str):
+    if isinstance(v, bool):
+        return v
+    if v.lower() in ("yes", "true", "t", "1"):
+        return True
+    if v.lower() in ("no", "false", "f", "0"):
+        return False
+    raise argparse.ArgumentTypeError("Boolean value expected.")
+
+
+class ToggleOrBool(argparse.Action):
+    def __call__(self, parser, namespace, values, option_string=None):
+        if values is None:
+            # toggle mode
+            current = getattr(namespace, self.dest, None)
+            default = self.default
+            setattr(namespace, self.dest, not default if current is None else not current)
+        else:
+            # explicit boolean mode
+            setattr(namespace, self.dest, str2bool(values))
+
+
+class CliGenerator:
+    """Generates a CLI automatically from a ConfigManager."""
+
+    def __init__(self, config_manager: ConfigManager, app_name: str = "app"):
+        self.config_manager = config_manager
+        self.app_name = app_name
+
+    # ----------------------------------------------------------------------
+    # Argument parser builder
+    # ----------------------------------------------------------------------
+    def create_argument_parser(self, description: str = None) -> argparse.ArgumentParser:
+        if description is None:
+            description = f"Command line interface for {self.app_name}"
+
+        parser = argparse.ArgumentParser(description=description)
+
+        # Config file argument
+        parser.add_argument("--config", help="Path to configuration file")
+
+        # verbosity
+        parser.add_argument("-v", "--verbose", action="store_true", help="Verbose logging")
+        parser.add_argument("-q", "--quiet", action="store_true", help="Quiet mode")
+
+        # CLI parameters
+        for p in self.config_manager.get_cli_parameters():
+            if p.required:  # POSITONAL ARGUMENT
+                parser.add_argument(p.name, help=p.help)
+                continue
+
+            # OPTIONAL FLAG
+            kwargs = {
+                "help": f"{p.help} (default: {p.value})",
+                "default": argparse.SUPPRESS,
+            }
+
+            # Handle different parameter types
+            if isinstance(p.value, bool):
+                kwargs["nargs"] = "?"  # allow optional argument
+                kwargs["default"] = p.value  # default remains as defined
+                kwargs["const"] = None  # triggers toggle mode
+                kwargs["action"] = ToggleOrBool
+            else:
+                kwargs["type"] = type(p.value)
+                if p.choices:
+                    kwargs["choices"] = p.choices
+
+            parser.add_argument(p.cli_arg, **kwargs)
+
+        return parser
+
+    # ----------------------------------------------------------------------
+    # convert args → config overrides
+    # ----------------------------------------------------------------------
+    def create_config_overrides(self, args: argparse.Namespace) -> dict[str, Any]:
+        overrides = {}
+
+        for p in self.config_manager.get_cli_parameters():
+            if hasattr(args, p.name):
+                overrides[f"{p.category}__{p.name}"] = getattr(args, p.name)
+
+        if getattr(args, "verbose", False):
+            overrides["app__log_level"] = "DEBUG"
+        elif getattr(args, "quiet", False):
+            overrides["app__log_level"] = "WARNING"
+
+        return overrides
+
+    # ----------------------------------------------------------------------
+    # Main CLI runner
+    # ----------------------------------------------------------------------
+    def run_cli(
+        self,
+        main_function: Callable[[ConfigManager], int],
+        description: str = None,
+        validator: Callable[[ConfigManager], bool] = None,
+    ) -> int:
+        parser = self.create_argument_parser(description)
+        args = parser.parse_args()
+
+        # Load config_file only ONCE
+        config = ConfigManager(
+            categories=tuple(self.config_manager._categories.values()),
+            config_file=getattr(args, "config", None),
+        )
+
+        # Apply CLI overrides
+        overrides = self.create_config_overrides(args)
+        config.apply_overrides(overrides)
+
+        # Try to get logger if logging is configured
+        try:
+            from .logging import get_logger
+
+            logger = get_logger(f"{self.app_name}.cli")
+            logger.info(f"Starting {self.app_name} CLI")
+            logger.debug(f"Command line arguments: {vars(args)}")
+        except ImportError:
+            pass
+
+        # Optional validation
+        if validator and not validator(config):
+            print("Configuration validation failed.")
+            return 1
+
+        # Execute main
+        try:
+            return main_function(config)
+        except KeyboardInterrupt:
+            print("Interrupted.")
+            return 130
+        except Exception as e:
+            print(f"Unexpected error: {e}")
+            traceback.print_exc()
+            return 1

{config_cli_gui-0.2.0 → config_cli_gui-0.2.2}/src/config_cli_gui/config.py

@@ -96,7 +96,7 @@ class ConfigManager:
 
     def __init__(
         self,
-        categories: tuple[ConfigCategory, ...],
+        categories: tuple[ConfigCategory, ...] = None,
         config_file: str | None = None,
         **overrides: Any,
     ):

{config_cli_gui-0.2.0 → config_cli_gui-0.2.2}/src/config_cli_gui.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: config-cli-gui
-Version: 0.2.0
+Version: 0.2.2
 Summary: Feature-rich Python project template for config-cli-gui.
 Author: pamagister
 Requires-Python: <3.12,>=3.10

{config_cli_gui-0.2.0 → config_cli_gui-0.2.2}/src/config_cli_gui.egg-info/SOURCES.txt

@@ -23,6 +23,8 @@ uv.lock
 .github/workflows/release.yml
 .github/workflows/update_readme.yml
 .idea/runConfigurations/config_generate.xml
+.idea/runConfigurations/example_project_cli.xml
+.idea/runConfigurations/example_project_gui.xml
 docs/.nav.yml
 docs/index.md
 docs/_static/img/favicon.png
@@ -54,11 +56,13 @@ src/config_cli_gui.egg-info/entry_points.txt
 src/config_cli_gui.egg-info/requires.txt
 src/config_cli_gui.egg-info/top_level.txt
 tests/__init__.py
+tests/test_cli.py
 tests/test_config_manager.py
 tests/test_docs.py
 tests/test_generic_cli.py
 tests/example_project/__init__.py
 tests/example_project/__main__.py
+tests/example_project/example.gpx
 tests/example_project/cli/__init__.py
 tests/example_project/cli/__main__.py
 tests/example_project/cli/cli_example.py

{config_cli_gui-0.2.0 → config_cli_gui-0.2.2}/tests/example_project/cli/cli_example.py

@@ -4,13 +4,12 @@ This file uses the CliGenerator from the generic config framework.
 """
 
 from config_cli_gui.cli import CliGenerator
-from config_cli_gui.config import ConfigManager
 from tests.example_project.config.config_example import ProjectConfigManager
 from tests.example_project.core.base import BaseGPXProcessor
 from tests.example_project.core.logging import initialize_logging
 
 
-def run_main_processing(_config: ConfigManager) -> int:
+def run_main_processing(_config: ProjectConfigManager) -> int:
     """Main processing function that gets called by the CLI generator.
 
     Args:
@@ -32,11 +31,12 @@ def run_main_processing(_config: ConfigManager) -> int:
 
         # Create and run BaseGPXProcessor
         processor = BaseGPXProcessor(
-            _config.get_category("cli").input,
-            _config.get_category("cli").output,
-            _config.get_category("cli").min_dist,
-            _config.get_category("app").date_format,
-            _config.get_category("cli").elevation,
+            _config.cli.input.value,
+            _config.cli.output.value,
+            _config.cli.min_dist.value,
+            _config.app.date_format.value,
+            _config.cli.elevation.value,
+            _config.cli.extract_waypoints.value,
             logger=logger,
         )
 
@@ -58,10 +58,11 @@ def main():
     # Create the base configuration manager
     config_manager = ProjectConfigManager()
 
-    # Create CLI generator
-    cli_generator = CliGenerator(config_manager=config_manager, app_name="config_cli_gui")
+    cli_generator = CliGenerator(
+        config_manager=config_manager,
+        app_name="config_cli_gui",
+    )
 
-    # Run the CLI with our main processing function
     return cli_generator.run_cli(
         main_function=run_main_processing,
         description="Example CLI for config-cli-gui using the generic config framework.",

{config_cli_gui-0.2.0 → config_cli_gui-0.2.2}/tests/example_project/config/config_example.py

@@ -56,7 +56,7 @@ class CliConfig(ConfigCategory):
 
     elevation: ConfigParameter = ConfigParameter(
         name="elevation",
-        value=True,
+        value=False,
         help="Include elevation data in waypoints",
         is_cli=True,
     )
@@ -181,7 +181,7 @@ class MiscConfig(ConfigCategory):
 
     some_date: ConfigParameter = ConfigParameter(
         name="some_date",
-        value=datetime.now(),
+        value=datetime.fromisoformat("2025-12-31 10:30:45"),
         help="Date setting for the application",
     )
 
@@ -202,9 +202,9 @@ class ProjectConfigManager(ConfigManager):  # Inherit from ConfigManager
 
 def main():
     """Main function to generate config file and documentation."""
-    default_config: str = "../../../config.yaml"
-    default_cli_doc: str = "../../../docs/usage/cli.md"
-    default_config_doc: str = "../../../docs/usage/config.md"
+    default_config: str = "config.yaml"
+    default_cli_doc: str = "docs/usage/cli.md"
+    default_config_doc: str = "docs/usage/config.md"
     _config = ProjectConfigManager()
     doc_gen = DocumentationGenerator(_config)
     doc_gen.generate_default_config_file(output_file=default_config)

{config_cli_gui-0.2.0 → config_cli_gui-0.2.2}/tests/example_project/core/base.py

@@ -11,6 +11,7 @@ class BaseGPXProcessor:
         min_dist=10,
         date_format="%Y-%m-%d",
         elevation=True,
+        extract_waypoints=True,
         logger=None,
     ):
         # ensure that input is converted into a list[Path]
@@ -29,7 +30,12 @@ class BaseGPXProcessor:
         self.include_elevation = elevation
         self.logger = logger
 
-        self.logger.info(f"example module successfully initialized with input: {self.input}")
+        self.logger.info("example module successfully initialized with:")
+        self.logger.info(f"output: {output}")
+        self.logger.info(f"min_dist: {min_dist}")
+        self.logger.info(f"date_format: {date_format}")
+        self.logger.info(f"elevation: {elevation}")
+        self.logger.info(f"extract_waypoints: {extract_waypoints}")
 
     def compress_files(self) -> list[str]:
         """Shrink the size of all given gpx/kml files in se