config-cli-gui 0.2.10__tar.gz → 0.3.1__tar.gz

{config_cli_gui-0.2.10 → config_cli_gui-0.3.1}/HISTORY.md

@@ -2,6 +2,34 @@ Changelog
 =========
 
 
+(unreleased)
+------------
+- Fix typings, improve cli test. [Paul Magister]
+- Update README.md from docs/index.md. [github-actions]
+- Improve doc. [Paul Magister]
+- Search for some more paths in windows. [Paul Magister]
+
+
+0.3.0 (2025-12-03)
+------------------
+- Docs: Update HISTORY.md for release 0.3.0. [Paul Magister]
+- Docs: Update HISTORY.md for release 0.2.9. [Paul Magister]
+- Refactoring: config parameters will stay ordered like in the config.
+  [Paul Magister]
+- Refactoring: config parameters will stay ordered like in the config.
+  [Paul Magister]
+- Refactor cli.py, move logging into this project. [Paul Magister]
+- Docs: Update HISTORY.md for release 0.2.9. [Paul Magister]
+- Docs: Update HISTORY.md for release 0.2.10. [Paul Magister]
+- Docs: Update HISTORY.md for release 0.2.9. [Paul Magister]
+- Update README.md from docs/index.md. [github-actions]
+
+
+0.2.10 (2025-12-03)
+-------------------
+- Docs: Update HISTORY.md for release 0.2.10. [Paul Magister]
+
+
 0.2.9 (2025-12-03)
 ------------------
 - Docs: Update HISTORY.md for release 0.2.9. [Paul Magister]

{config_cli_gui-0.2.10 → config_cli_gui-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: config-cli-gui
-Version: 0.2.10
+Version: 0.3.1
 Summary: Feature-rich Python project template for config-cli-gui.
 Author: pamagister
 Requires-Python: <3.12,>=3.10
@@ -63,11 +63,33 @@ pip install config-cli-gui
 ## ✨ Features
 
   * **Single Source of Truth**: Define all your application parameters in one place using simple, dataclass-like structures based on Pydantic's `BaseModel`. This ensures consistency and reduces errors across your application.
+
+    ```yaml
+    gui:
+      # GUI theme setting | type=str | choices=['light', 'dark', 'auto']
+      theme: light
+    misc:
+      # Example integer | type=int
+      some_numeric: 42
+      # Path to the file to use | type=PosixPath
+      some_file: some_file.txt
+      # Color setting for the application | type=Color
+      some_color: '#ff0000'
+      # Font setting for the application | type=Font
+      some_font: 'DejaVuSans.ttf, 12, #0000ff'
+    ```
+
   * **Categorized Configuration**: Organize your parameters into logical categories (e.g., `cli`, `app`, `gui`) for better structure and maintainability.
   * **Dynamic CLI Generation**: Automatically generate `argparse`-compatible command-line arguments directly from your defined configuration parameters, including help texts, types, and choices.
   * **Config File Management**: Easily load and save configurations from/to YAML or JSON files, allowing users to customize default settings.
   * **GUI Settings Dialogs**: Dynamically create Tkinter-based settings dialogs for your application, allowing users to intuitively modify configuration parameters via a graphical interface.
+
+    ![settings_dlg.png](_static/img/settings_dlg.png)
+ 
   * **Documentation Generation**: Generate detailed Markdown documentation for both your CLI options and all configuration parameters, keeping your user guides always up-to-date with your codebase.
+
+    ![settings_doc.png](_static/img/settings_doc.png)
+
   * **Override System**: Supports robust overriding of configuration values via configuration files and command-line arguments, with clear precedence.
 
 ---

{config_cli_gui-0.2.10 → config_cli_gui-0.3.1}/README.md

@@ -30,21 +30,38 @@ You can install `config-cli-gui` using pip:
 pip install config-cli-gui
 ```
 
-## Contribution
-
-Refer to this how-to in the referenced project for getting started to install and develop on this project:
-https://github.com/pamagister/python-template-project
-
 ---
 
 ## ✨ Features
 
   * **Single Source of Truth**: Define all your application parameters in one place using simple, dataclass-like structures based on Pydantic's `BaseModel`. This ensures consistency and reduces errors across your application.
+
+    ```yaml
+    gui:
+      # GUI theme setting | type=str | choices=['light', 'dark', 'auto']
+      theme: light
+    misc:
+      # Example integer | type=int
+      some_numeric: 42
+      # Path to the file to use | type=PosixPath
+      some_file: some_file.txt
+      # Color setting for the application | type=Color
+      some_color: '#ff0000'
+      # Font setting for the application | type=Font
+      some_font: 'DejaVuSans.ttf, 12, #0000ff'
+    ```
+
   * **Categorized Configuration**: Organize your parameters into logical categories (e.g., `cli`, `app`, `gui`) for better structure and maintainability.
   * **Dynamic CLI Generation**: Automatically generate `argparse`-compatible command-line arguments directly from your defined configuration parameters, including help texts, types, and choices.
   * **Config File Management**: Easily load and save configurations from/to YAML or JSON files, allowing users to customize default settings.
   * **GUI Settings Dialogs**: Dynamically create Tkinter-based settings dialogs for your application, allowing users to intuitively modify configuration parameters via a graphical interface.
+
+    ![settings_dlg.png](_static/img/settings_dlg.png)
+ 
   * **Documentation Generation**: Generate detailed Markdown documentation for both your CLI options and all configuration parameters, keeping your user guides always up-to-date with your codebase.
+
+    ![settings_doc.png](_static/img/settings_doc.png)
+
   * **Override System**: Supports robust overriding of configuration values via configuration files and command-line arguments, with clear precedence.
 
 ---
@@ -67,44 +84,27 @@ from config_cli_gui.config import (
     ConfigParameter,
 )
 from config_cli_gui.configtypes.color import Color
-from config_cli_gui.docs import DocumentationGenerator
+from config_cli_gui.configtypes.font import Font
+from config_cli_gui.configtypes.vector import Vector
 
 
-class CliConfig(ConfigCategory):
-    """CLI-specific configuration parameters."""
-
+class MiscConfig(ConfigCategory):
     def get_category_name(self) -> str:
-        return "cli"
-
-    # Positional argument
-    input: ConfigParameter = ConfigParameter(
-        name="input",
-        value="",
-        help="Path to input (file or folder)",
-        required=True,
-        is_cli=True,
-    )
+        return "misc"
 
-    # Optional CLI arguments
-    output: ConfigParameter = ConfigParameter(
-        name="output",
-        value="",
-        help="Path to output destination",
+    some_numeric: ConfigParameter = ConfigParameter(
+        name="some_numeric",
+        value=int(42),
+        help="Example integer",
         is_cli=True,
     )
 
-    min_dist: ConfigParameter = ConfigParameter(
-        name="min_dist",
-        value=20,
-        help="Maximum distance between two waypoints",
-        is_cli=True,
+    some_vector: ConfigParameter = ConfigParameter(
+        name="some_vector",
+        value=Vector(1, 2, 3),
+        help="Example vector",
     )
 
-
-class MiscConfig(ConfigCategory):
-    def get_category_name(self) -> str:
-        return "misc"
-
     some_file: ConfigParameter = ConfigParameter(
         name="some_file",
         value=Path("some_file.txt"),
@@ -119,20 +119,46 @@ 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",
     )
 
+    some_font: ConfigParameter = ConfigParameter(
+        name="some_font",
+        value=Font("DejaVuSans.ttf", size=12, color=Color(0, 0, 255)),
+        help="Font setting for the application",
+    )
+
+
+class AppConfig(ConfigCategory):
+    """Application-specific configuration parameters."""
+
+    def get_category_name(self) -> str:
+        return "app"
+
+    log_level: ConfigParameter = ConfigParameter(
+        name="log_level",
+        value="INFO",
+        choices=["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"],
+        help="Logging level for the application",
+    )
+
+    log_file_max_size: ConfigParameter = ConfigParameter(
+        name="log_file_max_size",
+        value=10,
+        help="Maximum log file size in MB before rotation",
+    )
+
 
 class ProjectConfigManager(ConfigManager):  # Inherit from ConfigManager
     """Main configuration manager that handles all parameter categories."""
 
-    cli: CliConfig
+    app: AppConfig
     misc: MiscConfig
-
+    
     def __init__(self, config_file: str | None = None, **kwargs):
         """Initialize the configuration manager with all parameter categories."""
-        categories = (CliConfig(), MiscConfig())
+        categories = (MiscConfig(), AppConfig())
         super().__init__(categories, config_file, **kwargs)
 
 

{config_cli_gui-0.2.10 → config_cli_gui-0.3.1}/config.yaml

@@ -1,63 +1,60 @@
+cli:
+  # Path to input (file or folder) | type=str | [CLI]
+  input: ''
+  # Path to output destination | type=str | [CLI]
+  output: ''
+  # Maximum distance between two waypoints | type=int | [CLI]
+  min_dist: 20
+  # Extract starting points of each track as waypoint | type=bool | [CLI] | choices=[True, False]
+  extract_waypoints: true
+  # Include elevation data in waypoints | type=bool | [CLI] | choices=[True, False]
+  elevation: false
 app:
   # Date format to use | type=str
   date_format: '%Y-%m-%d'
-  # Enable logging to console | type=bool | choices=[True, False]
-  enable_console_logging: true
-  # Enable logging to file | type=bool | choices=[True, False]
-  enable_file_logging: true
-  # Number of backup log files to keep | type=int
-  log_backup_count: 5
+  # Logging level for the application | type=str | choices=['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL']
+  log_level: INFO
   # Maximum log file size in MB before rotation | type=int
   log_file_max_size: 10
+  # Number of backup log files to keep | type=int
+  log_backup_count: 5
   # Log message format style | type=str | choices=['simple', 'detailed', 'json']
   log_format: detailed
-  # Logging level for the application | type=str | choices=['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL']
-  log_level: INFO
   # Maximum number of worker threads | type=int
   max_workers: 4
-cli:
-  # Include elevation data in waypoints | type=bool [CLI] | choices=[True, False]
-  elevation: false
-  # Extract starting points of each track as waypoint | type=bool [CLI] | choices=[True, False]
-  extract_waypoints: true
-  # Path to input (file or folder) | type=str [CLI]
-  input: ''
-  # Maximum distance between two waypoints | type=int [CLI]
-  min_dist: 20
-  # Path to output destination | type=str [CLI]
-  output: ''
+  # Enable logging to file | type=bool | choices=[True, False]
+  enable_file_logging: true
+  # Enable logging to console | type=bool | choices=[True, False]
+  enable_console_logging: true
 gui:
-  # Automatically scroll to the newest log entries | type=bool | choices=[True, False]
-  auto_scroll_log: true
+  # GUI theme setting | type=str | choices=['light', 'dark', 'auto']
+  theme: light
+  # Default window width | type=int
+  window_width: 800
+  # Default window height | type=int
+  window_height: 600
   # Height of the log window in pixels | type=int
   log_window_height: 200
+  # Automatically scroll to the newest log entries | type=bool | choices=[True, False]
+  auto_scroll_log: true
   # Maximum number of log lines to keep in GUI | type=int
   max_log_lines: 1000
   # Point in 2D space | type=Vector
   point2D: (7, 11)
   # Point in 3D space | type=Vector
   point3D: (1.2, 3.4, 5.6)
-  # GUI theme setting | type=str | choices=['light', 'dark', 'auto']
-  theme: light
-  # Default window height | type=int
-  window_height: 600
-  # Default window width | type=int
-  window_width: 800
 misc:
-  # Color setting for the application | type=Color
-  some_color: '#ff0000'
-  # Date setting for the application | type=datetime
-  some_date: '2025-12-31T10:30:45'
-  # Path to the file to use | type=PosixPath
-  some_file: some_file.txt
-  # Font setting for the application | type=Font
-  some_font:
-  - DejaVuSans.ttf
-  - 12
-  - '#0000ff'
   # Example integer | type=int
   some_numeric: 42
   # Example vector 2D | type=Vector
   some_vector2d: (1, 2)
   # Example vector 3D | type=Vector
-  some_vector3d: (1.1, 2.2, 3.3)
+  some_vector3d: (1.1, 2.2, 3.3)
+  # Path to the file to use | type=PosixPath
+  some_file: some_file.txt
+  # Color setting for the application | type=Color
+  some_color: '#ff0000'
+  # Date setting for the application | type=datetime
+  some_date: '2025-12-31T10:30:45'
+  # Font setting for the application | type=Font
+  some_font: 'DejaVuSans.ttf, 12, #0000ff'

{config_cli_gui-0.2.10 → config_cli_gui-0.3.1}/docs/index.md

@@ -33,11 +33,33 @@ pip install config-cli-gui
 ## ✨ Features
 
   * **Single Source of Truth**: Define all your application parameters in one place using simple, dataclass-like structures based on Pydantic's `BaseModel`. This ensures consistency and reduces errors across your application.
+
+    ```yaml
+    gui:
+      # GUI theme setting | type=str | choices=['light', 'dark', 'auto']
+      theme: light
+    misc:
+      # Example integer | type=int
+      some_numeric: 42
+      # Path to the file to use | type=PosixPath
+      some_file: some_file.txt
+      # Color setting for the application | type=Color
+      some_color: '#ff0000'
+      # Font setting for the application | type=Font
+      some_font: 'DejaVuSans.ttf, 12, #0000ff'
+    ```
+
   * **Categorized Configuration**: Organize your parameters into logical categories (e.g., `cli`, `app`, `gui`) for better structure and maintainability.
   * **Dynamic CLI Generation**: Automatically generate `argparse`-compatible command-line arguments directly from your defined configuration parameters, including help texts, types, and choices.
   * **Config File Management**: Easily load and save configurations from/to YAML or JSON files, allowing users to customize default settings.
   * **GUI Settings Dialogs**: Dynamically create Tkinter-based settings dialogs for your application, allowing users to intuitively modify configuration parameters via a graphical interface.
+
+    ![settings_dlg.png](_static/img/settings_dlg.png)
+ 
   * **Documentation Generation**: Generate detailed Markdown documentation for both your CLI options and all configuration parameters, keeping your user guides always up-to-date with your codebase.
+
+    ![settings_doc.png](_static/img/settings_doc.png)
+
   * **Override System**: Supports robust overriding of configuration values via configuration files and command-line arguments, with clear precedence.
 
 ---

{config_cli_gui-0.2.10 → config_cli_gui-0.3.1}/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.10'
-__version_tuple__ = version_tuple = (0, 2, 10)
+__version__ = version = '0.3.1'
+__version_tuple__ = version_tuple = (0, 3, 1)
 
-__commit_id__ = commit_id = 'g50c7157ad'
+__commit_id__ = commit_id = 'g32c96636f'

{config_cli_gui-0.2.10 → config_cli_gui-0.3.1}/src/config_cli_gui/cli.py

@@ -4,6 +4,7 @@
 import argparse
 import traceback
 from collections.abc import Callable
+from logging import Logger, getLogger
 from typing import Any
 
 from config_cli_gui.config import ConfigManager
@@ -61,7 +62,7 @@ class CliGenerator:
                 continue
 
             # OPTIONAL FLAG
-            kwargs = {
+            kwargs: dict[str, Any] = {
                 "help": f"{p.help} (default: {p.value})",
                 "default": argparse.SUPPRESS,
             }
@@ -103,16 +104,20 @@ class CliGenerator:
     # ----------------------------------------------------------------------
     def run_cli(
         self,
-        main_function: Callable[[ConfigManager], int],
+        main_function: Callable[[ConfigManager, Logger], int],
         description: str = None,
-        validator: Callable[[ConfigManager], bool] = None,
+        validator: Callable[[ConfigManager, Logger], bool] = None,
+        logger: Logger = None,
     ) -> int:
         parser = self.create_argument_parser(description)
         args = parser.parse_args()
 
+        if logger is None:
+            logger = getLogger(self.app_name)
+
         # Load config_file only ONCE
         config = ConfigManager(
-            categories=tuple(self.config_manager._categories.values()),
+            categories=self.config_manager.get_categories(),
             config_file=getattr(args, "config", None),
         )
 
@@ -121,17 +126,17 @@ class CliGenerator:
         config.apply_overrides(overrides)
 
         # Optional validation
-        if validator and not validator(config):
-            print("Configuration validation failed.")
+        if validator and not validator(config, logger):
+            logger.error("Configuration validation failed.")
             return 1
 
         # Execute main
         try:
-            return main_function(config)
+            return main_function(config, logger)
         except KeyboardInterrupt:
-            print("Interrupted.")
+            logger.info("Interrupted.")
             return 130
         except Exception as e:
-            print(f"Unexpected error: {e}")
-            traceback.print_exc()
+            logger.error(f"Unexpected error: {e}")
+            logger.debug(traceback.format_exc())
             return 1