config-cli-gui 0.2.5__tar.gz → 0.2.7__tar.gz

{config_cli_gui-0.2.5 → config_cli_gui-0.2.7}/HISTORY.md

@@ -4,6 +4,18 @@ Changelog
 
 (unreleased)
 ------------
+- Also show required params in gui. [Paul Magister]
+
+
+0.2.6 (2025-11-28)
+------------------
+- Docs: Update HISTORY.md for release 0.2.6. [Paul Magister]
+- Vector: Add property for 2d and 3d vectors. [Paul Magister]
+
+
+0.2.5 (2025-11-19)
+------------------
+- Docs: Update HISTORY.md for release 0.2.5. [Paul Magister]
 - Path widget: file or dir buttons. [Paul Magister]
 
 

{config_cli_gui-0.2.5 → config_cli_gui-0.2.7}/PKG-INFO

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

config_cli_gui-0.2.7/config.yaml

@@ -0,0 +1,52 @@
+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
+  # Maximum log file size in MB before rotation | type=int
+  log_file_max_size: 10
+  # 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: ''
+gui:
+  # Automatically scroll to the newest log entries | type=bool | choices=[True, False]
+  auto_scroll_log: true
+  # Height of the log window in pixels | type=int
+  log_window_height: 200
+  # 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

{config_cli_gui-0.2.5 → config_cli_gui-0.2.7}/docs/usage/config.md

@@ -28,14 +28,16 @@ The parameters in the cli category can be accessed via the command line interfac
 
 ## Category "gui"
 
-| Name              | Type | Description                                    | Default | Choices                   |
-|-------------------|------|------------------------------------------------|---------|---------------------------|
-| theme             | str  | GUI theme setting                              | 'light' | ['light', 'dark', 'auto'] |
-| window_width      | int  | Default window width                           | 800     | -                         |
-| window_height     | int  | Default window height                          | 600     | -                         |
-| log_window_height | int  | Height of the log window in pixels             | 200     | -                         |
-| auto_scroll_log   | bool | Automatically scroll to the newest log entries | True    | [True, False]             |
-| max_log_lines     | int  | Maximum number of log lines to keep in GUI     | 1000    | -                         |
+| Name              | Type   | Description                                    | Default               | Choices                   |
+|-------------------|--------|------------------------------------------------|-----------------------|---------------------------|
+| theme             | str    | GUI theme setting                              | 'light'               | ['light', 'dark', 'auto'] |
+| window_width      | int    | Default window width                           | 800                   | -                         |
+| window_height     | int    | Default window height                          | 600                   | -                         |
+| log_window_height | int    | Height of the log window in pixels             | 200                   | -                         |
+| auto_scroll_log   | bool   | Automatically scroll to the newest log entries | True                  | [True, False]             |
+| max_log_lines     | int    | Maximum number of log lines to keep in GUI     | 1000                  | -                         |
+| point2D           | Vector | Point in 2D space                              | Vector(7, 11)         | -                         |
+| point3D           | Vector | Point in 3D space                              | Vector(1.2, 3.4, 5.6) | -                         |
 
 ## Category "misc"
 

{config_cli_gui-0.2.5 → config_cli_gui-0.2.7}/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.5'
-__version_tuple__ = version_tuple = (0, 2, 5)
+__version__ = version = '0.2.7'
+__version_tuple__ = version_tuple = (0, 2, 7)
 
-__commit_id__ = commit_id = 'gda177fab1'
+__commit_id__ = commit_id = 'g56f4529b2'

{config_cli_gui-0.2.5 → config_cli_gui-0.2.7}/src/config_cli_gui/config.py

@@ -9,6 +9,39 @@ import yaml
 from pydantic import BaseModel
 
 
+class Vector:
+    """Class that represents a vector or point in 2D or 3D"""
+
+    def __init__(self, x: int | float, y: int | float, z: int | float | None = None):
+        self.x = x
+        self.y = y
+        self.z = z
+
+    def to_list(self) -> list[int]:
+        return [self.x, self.y, self.z] if self.z is not None else [self.x, self.y]
+
+    @classmethod
+    def from_list(cls, coordinate: list[int | str | float]) -> "Vector":
+        if len(coordinate) == 2:
+            return cls(float(coordinate[0]), float(coordinate[1]))
+        if len(coordinate) >= 3:
+            return cls(float(coordinate[0]), float(coordinate[1]), float(coordinate[2]))
+        return cls()
+
+    @classmethod
+    def from_str(cls, coordinate: str) -> "Vector":
+        return cls.from_list(coordinate.strip("()[]").split(","))
+
+    def to_str(self) -> str:
+        return f"({self.x}, {self.y}, {self.z})" if self.z is not None else f"({self.x}, {self.y})"  # type: ignore
+
+    def __str__(self):
+        return self.to_str()
+
+    def __repr__(self):
+        return f"Vector{str(self)}"
+
+
 class Color:
     """Simple color class for RGB values."""
 
@@ -168,6 +201,10 @@ class ConfigManager:
                     param_value = Color.from_list(param_value)
                 if isinstance(param.value, Color) and isinstance(param_value, str):
                     param_value = Color.from_hex(param_value)
+                if isinstance(param.value, Vector) and isinstance(param_value, list):
+                    param_value = Vector.from_list(param_value)
+                if isinstance(param.value, Vector) and isinstance(param_value, str):
+                    param_value = Vector.from_str(param_value)
                 elif isinstance(param.value, Path):
                     param_value = Path(param_value)
                 elif isinstance(param.value, datetime):
@@ -202,6 +239,8 @@ class ConfigManager:
                 val = getattr(category, param.name).value
                 if isinstance(val, Color):
                     val = val.to_hex()
+                elif isinstance(val, Vector):
+                    val = str(val.to_str())
                 elif isinstance(val, Path):
                     val = str(val.as_posix())
                 elif isinstance(val, datetime):
@@ -242,9 +281,11 @@ class ConfigManager:
                         indent = " " * (len(line) - len(stripped))
                         comment = (
                             f"{indent}# {param.help} | "
-                            f"type={param.type_.__name__}, default={param.value}"
+                            f"type={param.type_.__name__}"
                             f"{' [CLI]' if param.is_cli else ''}"
                         )
+                        if param.choices:
+                            comment = comment + f" | choices={param.choices}"
                         new_lines.append(comment)
 
             new_lines.append(line)

{config_cli_gui-0.2.5 → config_cli_gui-0.2.7}/src/config_cli_gui/gui.py

@@ -7,7 +7,7 @@ from datetime import datetime
 from pathlib import Path
 from tkinter import colorchooser, filedialog, messagebox, ttk
 
-from config_cli_gui.config import Color, ConfigCategory, ConfigManager, ConfigParameter
+from config_cli_gui.config import Color, ConfigCategory, ConfigManager, ConfigParameter, Vector
 
 
 class ToolTip:
@@ -271,9 +271,12 @@ class GenericSettingsDialog:
 
         for param in parameters:
             param.value = getattr(category, param.name).value
+
+            """
             if param.required:
                 # Skip required parameters as they are not configurable in GUI
                 continue
+            """
 
             # Create label
             label = ttk.Label(parent, text=f"{param.name}:")
@@ -315,6 +318,10 @@ class GenericSettingsDialog:
         elif isinstance(param.value, Color):
             return self._create_color_widget(parent, param)
 
+        # Vector type - Vector editor
+        elif isinstance(param.value, Vector):
+            return self._create_vector_widget(parent, param)
+
         # DateTime type - DateTime picker
         elif isinstance(param.value, datetime):
             return self._create_datetime_widget(parent, param)
@@ -421,6 +428,19 @@ class GenericSettingsDialog:
         frame.entry_widget = entry
         return frame
 
+    def _create_vector_widget(self, parent, param: ConfigParameter):
+        """Create vector editor widget."""
+        frame = ttk.Frame(parent)
+
+        vector_value = param.value if isinstance(param.value, Vector) else Vector()
+        var = tk.StringVar(value=vector_value.to_str().strip("()[]"))
+        entry = ttk.Entry(frame, textvariable=var)
+        entry.pack(side=tk.LEFT, fill=tk.X, expand=True)
+
+        frame.var = var
+        frame.entry_widget = entry
+        return frame
+
     def _create_datetime_widget(self, parent, param: ConfigParameter):
         """Create datetime picker widget."""
         frame = ttk.Frame(parent)
@@ -517,6 +537,8 @@ class GenericSettingsDialog:
                     import json
 
                     overrides[key] = json.loads(value)
+                elif type(param_value) == Vector:
+                    overrides[key] = Vector.from_str(value)
                 elif type(param_value) == int:
                     overrides[key] = int(value)
                 elif type(param_value) == float:

{config_cli_gui-0.2.5 → config_cli_gui-0.2.7}/src/config_cli_gui.egg-info/PKG-INFO

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

{config_cli_gui-0.2.5 → config_cli_gui-0.2.7}/tests/example_project/config/config_example.py

@@ -13,6 +13,7 @@ from config_cli_gui.config import (
     ConfigCategory,
     ConfigManager,
     ConfigParameter,
+    Vector,
 )
 from config_cli_gui.docs import DocumentationGenerator
 
@@ -162,6 +163,18 @@ class GuiConfig(ConfigCategory):
         help="Maximum number of log lines to keep in GUI",
     )
 
+    point2D: ConfigParameter = ConfigParameter(
+        name="point2D",
+        value=Vector(7, 11),
+        help="Point in 2D space",
+    )
+
+    point3D: ConfigParameter = ConfigParameter(
+        name="point3D",
+        value=Vector(1.2, 3.4, 5.6),
+        help="Point in 3D space",
+    )
+
 
 class MiscConfig(ConfigCategory):
     def get_category_name(self) -> str:

{config_cli_gui-0.2.5 → config_cli_gui-0.2.7}/tests/test_config_manager.py

@@ -10,6 +10,7 @@ from config_cli_gui.config import (
     ConfigCategory,
     ConfigManager,
     ConfigParameter,
+    Vector,
 )
 
 
@@ -38,6 +39,18 @@ def test_color_basic():
     assert str(c) == "#0033ff"
 
 
+def test_vector_2d():
+    v = Vector(1, 2)
+    assert v.to_list() == [1, 2]
+    assert str(v) == "(1, 2)"
+
+
+def test_vector_3d():
+    v = Vector.from_str("1.2, 2.3, 3.4")
+    assert v.to_list() == [1.2, 2.3, 3.4]
+    assert str(v) == "(1.2, 2.3, 3.4)"
+
+
 def test_color_clamping():
     c = Color(-5, 260, 500)
     assert c.to_list() == [0, 255, 255]

config_cli_gui-0.2.5/config.yaml

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