config-cli-gui 0.1.4__tar.gz → 0.1.6__tar.gz

{config_cli_gui-0.1.4 → config_cli_gui-0.1.6}/HISTORY.md

@@ -1,50 +1,72 @@
-Changelog
-=========
-
-
-(unreleased)
-------------
-- Update README.md from docs/index.md. [github-actions]
-- Feat #5: extensive renaming and adjustments. [Paul Magister]
-- Feat #5: extensive renaming. [Paul Magister]
-- Feat #5: extensive renaming. [Paul Magister]
-
-
-0.1.2 (2025-06-23)
-------------------
-- Feat #5: improve dialog. [Paul Magister]
-- Feat #5: Bugfig: use specific dialog for path parameters. [Paul
-  Magister]
-- Fix #4: fix test. [Paul Magister]
-- Fix #4: write yaml file with nicely with comments. [Paul Magister]
-- Fix #4: add comments to the yaml. [Paul Magister]
-- Fix #4: make new special datatypes work (Color, Path): correct
-  load/save lifecycle. [Paul Magister]
-- Feat #3: some advanced parameter types as example. [Paul Magister]
-- Feat #3: delete build workflow since it is not necessary for the lib.
-  [Paul Magister]
-- Feat #3: add verbose and quiet doc to auto generated config. [Paul
-  Magister]
-
-
-0.1.1 (2025-06-22)
-------------------
-- Feat #3: avoid type_ [Paul Magister]
-- Feat #3: Improved paramter types: [Paul Magister]
-- Feat #3: Improved paramter types: * move example project to tests *
-  remove type_ * add improved widgets to gui_generator.py * separate
-  module for docs_generator.py. [Paul Magister]
-
-
-0.1.0 (2025-06-22)
-------------------
-- Remove unnecessary example files and deps. [Paul Magister]
-- Update README.md from docs/index.md. [github-actions]
-- Fix doc: formatting. [Paul Magister]
-
-
-0.0.2 (2025-06-22)
-------------------
-- Remove _version.py. [Paul Magister]
-
-
+Changelog
+=========
+
+
+0.1.5 (2025-11-12)
+------------------
+- Docs: Update HISTORY.md for release 0.1.5. [paul]
+- #8 switch to value instead of default. [paul]
+- #8 adjust doc: how to develop. [paul]
+- #8 allow direct access to attributes without get_category #8. [paul]
+
+
+0.1.4 (2025-06-23)
+------------------
+- Feat #5: extensive renaming. [Paul Magister]
+
+
+0.1.3 (2025-06-23)
+------------------
+- Update README.md from docs/index.md. [github-actions]
+- Feat #5: extensive renaming and adjustments. [Paul Magister]
+- Feat #5: extensive renaming. [Paul Magister]
+- Feat #5: extensive renaming. [Paul Magister]
+
+
+0.1.2 (2025-06-23)
+------------------
+- Feat #5: improve dialog. [Paul Magister]
+- Feat #5: Bugfig: use specific dialog for path parameters. [Paul
+  Magister]
+- Fix #4: fix test. [Paul Magister]
+- Fix #4: write yaml file with nicely with comments. [Paul Magister]
+- Fix #4: add comments to the yaml. [Paul Magister]
+- Fix #4: make new special datatypes work (Color, Path): correct
+  load/save lifecycle. [Paul Magister]
+- Feat #3: some advanced parameter types as example. [Paul Magister]
+- Feat #3: delete build workflow since it is not necessary for the lib.
+  [Paul Magister]
+- Feat #3: add verbose and quiet doc to auto generated config. [Paul
+  Magister]
+
+
+0.1.1 (2025-06-22)
+------------------
+- Feat #3: avoid type_ [Paul Magister]
+- Feat #3: Improved paramter types: [Paul Magister]
+- Feat #3: Improved paramter types: * move example project to tests *
+  remove type_ * add improved widgets to gui_generator.py * separate
+  module for docs_generator.py. [Paul Magister]
+
+
+0.1.0 (2025-06-22)
+------------------
+- Remove unnecessary example files and deps. [Paul Magister]
+- Update README.md from docs/index.md. [github-actions]
+- Fix doc: formatting. [Paul Magister]
+
+
+0.0.2 (2025-06-22)
+------------------
+- Remove _version.py. [Paul Magister]
+
+
+0.0.1 (2025-06-22)
+------------------
+- Fix fmt. [Paul Magister]
+- Doc update. [Paul Magister]
+- First actual commit: cleanup. [Paul Magister]
+- ✅ Project renamed from template. [github-actions[bot]]
+- Initial commit. [Paul Magister]
+
+

{config_cli_gui-0.1.4 → config_cli_gui-0.1.6}/PKG-INFO

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

{config_cli_gui-0.1.4 → config_cli_gui-0.1.6}/README.md

@@ -30,6 +30,11 @@ 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

config_cli_gui-0.1.6/config.yaml

@@ -0,0 +1,51 @@
+app:
+  # Date format to use | type=str, default value=%Y-%m-%d
+  date_format: '%Y-%m-%d'
+  # Enable logging to console | type=bool, default value=True
+  enable_console_logging: true
+  # Enable logging to file | type=bool, default value=True
+  enable_file_logging: true
+  # Number of backup log files to keep | type=int, default value=5
+  log_backup_count: 5
+  # Maximum log file size in MB before rotation | type=int, default value=10
+  log_file_max_size: 10
+  # Log message format style | type=str, default value=detailed
+  log_format: detailed
+  # Logging level for the application | type=str, default value=INFO
+  log_level: INFO
+  # Maximum number of worker threads | type=int, default value=4
+  max_workers: 4
+cli:
+  # Include elevation data in waypoints | type=bool, default value=True [CLI]
+  elevation: true
+  # Extract starting points of each track as waypoint | type=bool, default value=True [CLI]
+  extract_waypoints: true
+  # Path to input (file or folder) | type=str, default value= [CLI]
+  input: ''
+  # Maximum distance between two waypoints | type=int, default value=20 [CLI]
+  min_dist: 20
+  # Path to output destination | type=str, default value= [CLI]
+  output: ''
+gui:
+  # Automatically scroll to the newest log entries | type=bool, default value=True
+  auto_scroll_log: true
+  # Height of the log window in pixels | type=int, default value=200
+  log_window_height: 200
+  # Maximum number of log lines to keep in GUI | type=int, default value=1000
+  max_log_lines: 1000
+  # GUI theme setting | type=str, default value=light
+  theme: light
+  # Default window height | type=int, default value=600
+  window_height: 600
+  # Default window width | type=int, default value=800
+  window_width: 800
+misc:
+  # Color setting for the application | type=Color, default value=#ff0000
+  some_color:
+  - 255
+  - 0
+  - 0
+  # Date setting for the application | type=datetime, default value=2025-11-12 22:24:14.121460
+  some_date: '2025-11-12T22:24:14.121460'
+  # Path to the file to use | type=PosixPath, default value=some_file.txt
+  some_file: some_file.txt

{config_cli_gui-0.1.4 → config_cli_gui-0.1.6}/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  | WindowsPath | Path to the file to use           | WindowsPath('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, 6, 24, 0, 19, 57, 95774) | -       |
+| 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, 12, 22, 24, 14, 121460) | -       |
 

{config_cli_gui-0.1.4 → config_cli_gui-0.1.6}/src/config_cli_gui/_version.py

@@ -1,7 +1,14 @@
 # file generated by setuptools-scm
 # don't change, don't track in version control
 
-__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
 
 TYPE_CHECKING = False
 if TYPE_CHECKING:
@@ -9,13 +16,19 @@ if TYPE_CHECKING:
     from typing import Union
 
     VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
 else:
     VERSION_TUPLE = object
+    COMMIT_ID = object
 
 version: str
 __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
 
-__version__ = version = '0.1.4'
-__version_tuple__ = version_tuple = (0, 1, 4)
+__version__ = version = '0.1.6'
+__version_tuple__ = version_tuple = (0, 1, 6)
+
+__commit_id__ = commit_id = 'gd42f29151'

{config_cli_gui-0.1.4 → config_cli_gui-0.1.6}/src/config_cli_gui/cli.py

@@ -46,7 +46,7 @@ class CliGenerator:
 
         # Generate arguments from CLI config parameters
         for param in cli_params:
-            param_type = type(param.default)
+            param_type = type(param.value)
 
             if param.required and param.cli_arg is None:
                 # Positional argument
@@ -54,8 +54,8 @@ class CliGenerator:
             else:
                 # Optional argument
                 kwargs = {
-                    "default": argparse.SUPPRESS,
-                    "help": f"{param.help} (default: {param.default})",
+                    "value": argparse.SUPPRESS,
+                    "help": f"{param.help} (value: {param.value})",
                 }
 
                 # Handle different parameter types
@@ -67,8 +67,8 @@ class CliGenerator:
                 elif param_type == float:
                     kwargs["type"] = float
                 elif param_type == bool:
-                    kwargs["action"] = "store_true" if not param.default else "store_false"
-                    kwargs["help"] = f"{param.help} (default: {param.default})"
+                    kwargs["action"] = "store_true" if not param.value else "store_false"
+                    kwargs["help"] = f"{param.help} (value: {param.value})"
                 elif param_type == str:
                     kwargs["type"] = str
 

{config_cli_gui-0.1.4 → config_cli_gui-0.1.6}/src/config_cli_gui/config.py

@@ -48,7 +48,7 @@ class ConfigParameter:
     """Represents a single configuration parameter with all its metadata."""
 
     name: str
-    default: Any
+    value: Any
     choices: list | tuple | None = None
     help: str = ""
     cli_arg: str = None
@@ -59,13 +59,13 @@ class ConfigParameter:
     def __post_init__(self):
         if self.is_cli and self.cli_arg is None and not self.required:
             self.cli_arg = f"--{self.name}"
-        if isinstance(self.default, bool) and self.choices is None:
+        if isinstance(self.value, bool) and self.choices is None:
             self.choices = [True, False]
 
     @property
     def type_(self) -> type:
-        """Get the type from the default value."""
-        return type(self.default)
+        """Get the type from the value."""
+        return type(self.value)
 
 
 class ConfigCategory(BaseModel, ABC):
@@ -73,14 +73,13 @@ class ConfigCategory(BaseModel, ABC):
 
     @abstractmethod
     def get_category_name(self) -> str:
-        """Return the category name for this configuration group."""
         pass
 
     def get_parameters(self) -> list[ConfigParameter]:
         """Get all ConfigParameter objects from this category."""
         parameters = []
         for field_name in self.__class__.model_fields:
-            param = getattr(self, field_name)
+            param = self.model_fields[field_name].default
             if isinstance(param, ConfigParameter):
                 param.category = self.get_category_name()
                 parameters.append(param)
@@ -99,19 +98,18 @@ class ConfigManager:
         """
         self._categories: dict[str, ConfigCategory] = {}
 
+        # Register categories and make accessible as attributes
         for category in categories:
-            if isinstance(category, ConfigCategory):
-                self.add_category(category.get_category_name(), category)
-            else:
+            if not isinstance(category, ConfigCategory):
                 raise TypeError(
-                    f"Category must be an instance of BaseConfigCategory, got {type(category)}"
+                    f"Category must be an instance of ConfigCategory, got {type(category)}"
                 )
+            name = category.get_category_name()
+            self.add_category(name, category)
 
-        # Load from file if provided
         if config_file:
             self.load_from_file(config_file)
 
-        # Override with provided kwargs
         self._apply_kwargs(kwargs)
 
     def add_category(self, name: str, category: ConfigCategory):
@@ -122,58 +120,46 @@ class ConfigManager:
             category: Configuration category instance
         """
         self._categories[name] = category
+        setattr(self, name, category)
 
     def get_category(self, name: str) -> ConfigCategory:
-        """Get a configuration category by name."""
         return self._categories.get(name)
 
     def _apply_kwargs(self, kwargs: dict[str, Any]):
-        """Apply keyword arguments to override configuration values."""
+        """Apply keyword overrides: category__param=value"""
         for key, value in kwargs.items():
             if "__" in key:
                 category_name, param_name = key.split("__", 1)
                 if category_name in self._categories:
                     category = self._categories[category_name]
                     if hasattr(category, param_name):
-                        param = getattr(category, param_name)
-                        if isinstance(param, ConfigParameter):
-                            param.default = value
+                        setattr(category, param_name, value)
 
     def load_from_file(self, config_file: str):
-        """Load configuration from JSON or YAML file."""
-        config_path = Path(config_file)
-        if not config_path.exists():
+        path = Path(config_file)
+        if not path.exists():
             raise FileNotFoundError(f"Configuration file not found: {config_file}")
-
-        with open(config_path, "r", encoding="utf-8") as f:
-            if config_path.suffix.lower() in [".yml", ".yaml"]:
-                config_data = yaml.safe_load(f)
-            else:
-                config_data = json.load(f)
-
-        # Store loaded data for later application
-        self._apply_config_data(config_data)
-
-    def _apply_config_data(self, _loaded_config_data):
-        """Apply configuration data to categories."""
-
-        # Apply loaded configuration
-        for category_name, category_data in _loaded_config_data.items():
-            if category_name in self._categories:
-                category = self._categories[category_name]
-                for param_name, param_value in category_data.items():
-                    if hasattr(category, param_name):
-                        param = getattr(category, param_name)
-                        if isinstance(param, ConfigParameter):
-                            # Handle special types
-                            if isinstance(param.default, Color) and isinstance(param_value, list):
-                                param.default = Color.from_list(param_value)
-                            elif isinstance(param.default, Path):
-                                param.default = Path(param_value)
-                            elif isinstance(param.default, datetime):
-                                param.default = datetime.fromisoformat(param_value)
-                            else:
-                                param.default = param_value
+        with open(path, "r", encoding="utf-8") as f:
+            data = yaml.safe_load(f) if path.suffix in [".yml", ".yaml"] else json.load(f)
+        self._apply_config_data(data)
+
+    def _apply_config_data(self, data: dict):
+        for category_name, category_data in data.items():
+            category = self._categories.get(category_name)
+            if not category:
+                continue
+            for param_name, param_value in category_data.items():
+                if hasattr(category, param_name):
+                    param = category.model_fields.get(param_name).default
+                    if isinstance(param, ConfigParameter):
+                        default_value = getattr(category, param_name)
+                        if isinstance(default_value, Color) and isinstance(param_value, list):
+                            param_value = Color.from_list(param_value)
+                        elif isinstance(default_value, Path):
+                            param_value = Path(param_value)
+                        elif isinstance(default_value, datetime):
+                            param_value = datetime.fromisoformat(param_value)
+                        setattr(getattr(self, category_name), param_name, param_value)
 
     def save_to_file(self, config_file: str, format_: str = "auto"):
         """Save current configuration to file with enhanced YAML formatting and comments.
@@ -182,34 +168,28 @@ class ConfigManager:
             config_file (str): The path to the configuration file.
             format_ (str): The format to save the file in ('auto', 'json', 'yaml').
         """
-        config_path = Path(config_file)
-        config_data = self.to_dict()
+        path = Path(config_file)
+        data = self.to_dict()
 
-        # Determine format
         if format_ == "auto":
-            format_ = "yaml" if config_path.suffix.lower() in [".yml", ".yaml"] else "json"
-
-        # Ensure directory exists
-        config_path.parent.mkdir(parents=True, exist_ok=True)
+            format_ = "yaml" if path.suffix in [".yml", ".yaml"] else "json"
 
-        with open(config_path, "w", encoding="utf-8") as f:
+        path.parent.mkdir(parents=True, exist_ok=True)
+        with open(path, "w", encoding="utf-8") as f:
             if format_ == "yaml":
-                yaml.dump(config_data, f, default_flow_style=False, indent=2)
+                yaml.dump(data, f, indent=2)
             else:
-                json.dump(config_data, f, indent=2)
+                json.dump(data, f, indent=2)
 
-        # Append comments for YAML files
         if format_ == "yaml":
-            self._append_comments_to_yaml(config_path)
+            self._append_comments_to_yaml(path)
 
     def to_dict(self) -> dict[str, Any]:
-        """Convert configuration to dictionary."""
         result = {}
-        for category_name, category in self._categories.items():
+        for name, category in self._categories.items():
             category_dict = {}
             for param in category.get_parameters():
-                value = param.default
-                # Handle special types for serialization
+                value = getattr(category, param.name).value
                 if isinstance(value, Color):
                     value = value.to_list()
                 elif isinstance(value, Path):
@@ -217,64 +197,49 @@ class ConfigManager:
                 elif isinstance(value, datetime):
                     value = value.isoformat()
                 category_dict[param.name] = value
-            result[category_name] = category_dict
+            result[name] = category_dict
         return result
 
     def get_all_parameters(self) -> list[ConfigParameter]:
-        """Get all parameters from all categories."""
-        parameters = []
-        for category in self._categories.values():
-            parameters.extend(category.get_parameters())
-        return parameters
+        return [p for c in self._categories.values() for p in c.get_parameters()]
 
     def get_cli_parameters(self) -> list[ConfigParameter]:
-        """Get parameters that are CLI-enabled."""
-        cli_parameters = []
-        for category in self._categories.values():
-            for param in category.get_parameters():
-                if param.is_cli:
-                    cli_parameters.append(param)
-        return cli_parameters
+        return [p for p in self.get_all_parameters() if p.is_cli]
 
-    def _append_comments_to_yaml(self, config_path: Path):
+    def _append_comments_to_yaml(self, path: Path):
         """Appends comments to a YAML file based on ConfigParameter metadata.
 
         Args:
             config_path (Path): The path to the YAML configuration file.
         """
-        lines = config_path.read_text(encoding="utf-8").splitlines()
+
+        lines = path.read_text(encoding="utf-8").splitlines()
         new_lines = []
         all_parameters = {param.name: param for param in self.get_all_parameters()}
         current_category = None
 
         for line in lines:
-            stripped_line = line.strip()
-            # Check for category (e.g., 'app:')
-            # A category should end with ':', not start with '#', and not be indented.
+            stripped = line.strip()
             if (
-                stripped_line.endswith(":")
-                and not stripped_line.startswith("#")
-                and line.startswith(stripped_line)
+                stripped.endswith(":")
+                and not stripped.startswith("#")
+                and line.startswith(stripped)
             ):
-                current_category = stripped_line[:-1]
+                current_category = stripped[:-1]
                 new_lines.append(line)
             else:
-                # Check for parameter (e.g., '  date_format: '%Y-%m-%d'')
-                # This needs to handle cases where the value spans multiple lines
-                parts = stripped_line.split(":", 1)
-                if len(parts) > 1:  # This line might be a parameter definition
+                parts = stripped.split(":", 1)
+                if len(parts) > 1:
                     param_name = parts[0].strip()
                     if param_name in all_parameters:
                         param = all_parameters[param_name]
-                        # Ensure the parameter belongs to the current category
-                        # and is not a sub-item of a multi-line value
                         if current_category and param.category == current_category:
-                            comment_indent = " " * (len(line) - len(stripped_line))
+                            indent = " " * (len(line) - len(stripped))
                             comment = (
-                                f"{comment_indent}# {param.help} | "
-                                f"type={type(param.default).__name__}, default={param.default}"
+                                f"{indent}# {param.help} | "
+                                f"type={type(param.value).__name__}, default value={param.value}"
                                 f"{' [CLI]' if param.is_cli else ''}"
                             )
                             new_lines.append(comment)
                 new_lines.append(line)
-        config_path.write_text("\n".join(new_lines), encoding="utf-8")
+        path.write_text("\n".join(new_lines), encoding="utf-8")

{config_cli_gui-0.1.4 → config_cli_gui-0.1.6}/src/config_cli_gui/docs.py

@@ -33,12 +33,12 @@ class DocumentationGenerator:
 
             for param in category.get_parameters():
                 name = param.name
-                typ = type(param.default).__name__
+                typ = type(param.value).__name__
                 desc = param.help
-                default = repr(param.default)
+                value = repr(param.value)
                 choices = str(param.choices) if param.choices else "-"
 
-                rows.append((name, typ, desc, default, choices))
+                rows.append((name, typ, desc, value, choices))
 
             if not rows:
                 continue
@@ -85,17 +85,15 @@ class DocumentationGenerator:
 
         for param in cli_params:
             cli_arg = f"`--{param.name}`" if not param.required else f"`{param.name}`"
-            typ = type(param.default).__name__
+            typ = type(param.value).__name__
             desc = param.help
-            default = (
-                "*required*"
-                if param.required or param.default in (None, "")
-                else repr(param.default)
+            value = (
+                "*required*" if param.required or param.value in (None, "") else repr(param.value)
             )
             choices = str(param.choices) if param.choices else "-"
 
-            rows.append((cli_arg, typ, desc, default, choices))
-            if default == "*required*":
+            rows.append((cli_arg, typ, desc, value, choices))
+            if value == "*required*":
                 required_params.append(param)
             else:
                 optional_params.append(param)
@@ -165,7 +163,7 @@ class DocumentationGenerator:
         for i, param in enumerate(optional_params[:3], 4):
             if param.name in ["verbose", "quiet"]:
                 continue
-            example_value = param.choices[0] if param.choices else param.default
+            example_value = param.choices[0] if param.choices else param.value
             examples.append(
                 dedent(f"""
                 ### {i}. With {param.name} parameter