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

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

@@ -4,6 +4,22 @@ Changelog
 
 (unreleased)
 ------------
+- Spinbox for vector. [Paul Magister]
+- Better example, make get_image_font sensitive to dpi, [Paul Magister]
+
+
+0.2.8 (2025-12-02)
+------------------
+- Docs: Update HISTORY.md for release 0.2.8. [Paul Magister]
+- Refactoring: get_image_font will look for the actual font path in the
+  system. [Paul Magister]
+- Font preview. [Paul Magister]
+- Add font category in config.py. [Paul Magister]
+
+
+0.2.7 (2025-11-29)
+------------------
+- Docs: Update HISTORY.md for release 0.2.7. [Paul Magister]
 - Also show required params in gui. [Paul Magister]
 
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: config-cli-gui
-Version: 0.2.7
+Version: 0.2.9
 Summary: Feature-rich Python project template for config-cli-gui.
 Author: pamagister
 Requires-Python: <3.12,>=3.10
@@ -8,6 +8,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: pydantic>=2.11.7
 Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: pillow>=12.0.0
 Provides-Extra: dev
 Requires-Dist: pytest>=8.4.0; extra == "dev"
 Requires-Dist: pytest-mock>=3.14.1; extra == "dev"
@@ -80,40 +81,58 @@ Start by defining your application's configuration parameters in a central `conf
 ```python
 # my_project/config_example.py
 
+from datetime import datetime
+from pathlib import Path
+
 from config_cli_gui.config import (
     ConfigCategory,
     ConfigManager,
     ConfigParameter,
 )
+from config_cli_gui.configtypes.color import Color
+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",
-        default="",
-        help="Path to input (file or folder)",
-        required=True,
+        return "misc"
+
+    some_numeric: ConfigParameter = ConfigParameter(
+        name="some_numeric",
+        value=int(42),
+        help="Example integer",
         is_cli=True,
     )
 
-    min_dist: ConfigParameter = ConfigParameter(
-        name="min_dist",
-        default=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",
     )
 
-    extract_waypoints: ConfigParameter = ConfigParameter(
-        name="extract_waypoints",
-        default=True,
-        help="Extract starting points of each track as waypoint",
-        is_cli=True,
+    some_file: ConfigParameter = ConfigParameter(
+        name="some_file",
+        value=Path("some_file.txt"),
+        help="Path to the file to use",
+    )
+
+    some_color: ConfigParameter = ConfigParameter(
+        name="some_color",
+        value=Color(255, 0, 0),
+        help="Color setting for the application",
+    )
+
+    some_date: ConfigParameter = ConfigParameter(
+        name="some_date",
+        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",
     )
 
 
@@ -125,14 +144,14 @@ class AppConfig(ConfigCategory):
 
     log_level: ConfigParameter = ConfigParameter(
         name="log_level",
-        default="INFO",
+        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",
-        default=10,
+        value=10,
         help="Maximum log file size in MB before rotation",
     )
 
@@ -140,11 +159,13 @@ class AppConfig(ConfigCategory):
 class ProjectConfigManager(ConfigManager):  # Inherit from ConfigManager
     """Main configuration manager that handles all parameter categories."""
 
-    categories = (CliConfig(), AppConfig())
-
+    app: AppConfig
+    misc: MiscConfig
+    
     def __init__(self, config_file: str | None = None, **kwargs):
         """Initialize the configuration manager with all parameter categories."""
-        super().__init__(self.categories, config_file, **kwargs)
+        categories = (MiscConfig(), AppConfig())
+        super().__init__(categories, config_file, **kwargs)
 
 
 ```

{config_cli_gui-0.2.7 → config_cli_gui-0.2.9}/README.md

@@ -62,11 +62,11 @@ from datetime import datetime
 from pathlib import Path
 
 from config_cli_gui.config import (
-    Color,
     ConfigCategory,
     ConfigManager,
     ConfigParameter,
 )
+from config_cli_gui.configtypes.color import Color
 from config_cli_gui.docs import DocumentationGenerator
 
 

{config_cli_gui-0.2.7 → config_cli_gui-0.2.9}/config.yaml

@@ -49,4 +49,15 @@ misc:
   # 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
+  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)

{config_cli_gui-0.2.7 → config_cli_gui-0.2.9}/docs/index.md

@@ -51,40 +51,58 @@ Start by defining your application's configuration parameters in a central `conf
 ```python
 # my_project/config_example.py
 
+from datetime import datetime
+from pathlib import Path
+
 from config_cli_gui.config import (
     ConfigCategory,
     ConfigManager,
     ConfigParameter,
 )
+from config_cli_gui.configtypes.color import Color
+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",
-        default="",
-        help="Path to input (file or folder)",
-        required=True,
+        return "misc"
+
+    some_numeric: ConfigParameter = ConfigParameter(
+        name="some_numeric",
+        value=int(42),
+        help="Example integer",
         is_cli=True,
     )
 
-    min_dist: ConfigParameter = ConfigParameter(
-        name="min_dist",
-        default=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",
     )
 
-    extract_waypoints: ConfigParameter = ConfigParameter(
-        name="extract_waypoints",
-        default=True,
-        help="Extract starting points of each track as waypoint",
-        is_cli=True,
+    some_file: ConfigParameter = ConfigParameter(
+        name="some_file",
+        value=Path("some_file.txt"),
+        help="Path to the file to use",
+    )
+
+    some_color: ConfigParameter = ConfigParameter(
+        name="some_color",
+        value=Color(255, 0, 0),
+        help="Color setting for the application",
+    )
+
+    some_date: ConfigParameter = ConfigParameter(
+        name="some_date",
+        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",
     )
 
 
@@ -96,14 +114,14 @@ class AppConfig(ConfigCategory):
 
     log_level: ConfigParameter = ConfigParameter(
         name="log_level",
-        default="INFO",
+        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",
-        default=10,
+        value=10,
         help="Maximum log file size in MB before rotation",
     )
 
@@ -111,11 +129,13 @@ class AppConfig(ConfigCategory):
 class ProjectConfigManager(ConfigManager):  # Inherit from ConfigManager
     """Main configuration manager that handles all parameter categories."""
 
-    categories = (CliConfig(), AppConfig())
-
+    app: AppConfig
+    misc: MiscConfig
+    
     def __init__(self, config_file: str | None = None, **kwargs):
         """Initialize the configuration manager with all parameter categories."""
-        super().__init__(self.categories, config_file, **kwargs)
+        categories = (MiscConfig(), AppConfig())
+        super().__init__(categories, config_file, **kwargs)
 
 
 ```

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

@@ -41,9 +41,13 @@ 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, 12, 31, 10, 30, 45) | -       |
+| Name          | Type      | Description                       | Default                                                      | Choices |
+|---------------|-----------|-----------------------------------|--------------------------------------------------------------|---------|
+| some_numeric  | int       | Example integer                   | 42                                                           | -       |
+| some_vector2d | Vector    | Example vector 2D                 | Vector(1, 2)                                                 | -       |
+| some_vector3d | Vector    | Example vector 3D                 | Vector(1.1, 2.2, 3.3)                                        | -       |
+| 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)                  | -       |
+| some_font     | Font      | Font setting for the application  | Font(type='DejaVuSans.ttf', size=12, color=Color(0, 0, 255)) | -       |
 

{config_cli_gui-0.2.7 → config_cli_gui-0.2.9}/pyproject.toml

@@ -10,6 +10,7 @@ requires-python = ">=3.10,<3.12"
 dependencies = [
     "pydantic>=2.11.7",
     "pyyaml>=6.0.2",
+    "pillow>=12.0.0",
 ]
 
 # Dev dependencies as optional dependencies

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

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

@@ -8,83 +8,9 @@ from typing import Any
 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."""
-
-    def __init__(self, r: int = 0, g: int = 0, b: int = 0):
-        self.r = max(0, min(255, r))
-        self.g = max(0, min(255, g))
-        self.b = max(0, min(255, b))
-
-    def to_list(self) -> list[int]:
-        return [self.r, self.g, self.b]
-
-    def to_rgb(self) -> tuple[float]:
-        return (self.r / 255, self.g / 255, self.b / 255)
-
-    def to_pil(self) -> tuple[int, ...]:
-        """Convert Color object to Pillow-compatible RGB tuple."""
-        return tuple(int(c) for c in self.to_list())
-
-    def to_hex(self) -> str:
-        return f"#{self.r:02x}{self.g:02x}{self.b:02x}"
-
-    @classmethod
-    def from_list(cls, rgb_list: list[int | str]) -> "Color":
-        if len(rgb_list) >= 3:
-            return cls(int(rgb_list[0]), int(rgb_list[1]), int(rgb_list[2]))
-        return cls()
-
-    @classmethod
-    def from_hex(cls, hex_color: str) -> "Color":
-        hex_color = hex_color.lstrip("#")
-        if len(hex_color) == 6:
-            return cls(
-                int(hex_color[0:2], 16),
-                int(hex_color[2:4], 16),
-                int(hex_color[4:6], 16),
-            )
-        return cls()
-
-    def __str__(self):
-        return self.to_hex()
-
-    def __repr__(self):
-        return f"Color({self.r}, {self.g}, {self.b})"
+from config_cli_gui.configtypes.color import Color
+from config_cli_gui.configtypes.font import Font
+from config_cli_gui.configtypes.vector import Vector
 
 
 @dataclass
@@ -197,6 +123,8 @@ class ConfigManager:
                     continue
 
                 # Type conversions
+                if isinstance(param.value, Font) and isinstance(param_value, list):
+                    param_value = Font.from_list(param_value)
                 if isinstance(param.value, Color) and isinstance(param_value, list):
                     param_value = Color.from_list(param_value)
                 if isinstance(param.value, Color) and isinstance(param_value, str):
@@ -237,7 +165,9 @@ class ConfigManager:
             result[category_name] = {}
             for param in category.get_parameters():
                 val = getattr(category, param.name).value
-                if isinstance(val, Color):
+                if isinstance(val, Font):
+                    val = val.to_list()
+                elif isinstance(val, Color):
                     val = val.to_hex()
                 elif isinstance(val, Vector):
                     val = str(val.to_str())

config_cli_gui-0.2.9/src/config_cli_gui/configtypes/color.py

@@ -0,0 +1,43 @@
+class Color:
+    """Simple color class for RGB values."""
+
+    def __init__(self, r: int = 0, g: int = 0, b: int = 0):
+        self.r = max(0, min(255, r))
+        self.g = max(0, min(255, g))
+        self.b = max(0, min(255, b))
+
+    def to_list(self) -> list[int]:
+        return [self.r, self.g, self.b]
+
+    def to_rgb(self) -> tuple[float, float, float]:
+        return self.r / 255, self.g / 255, self.b / 255
+
+    def to_pil(self) -> tuple[int, ...]:
+        """Convert Color object to Pillow-compatible RGB tuple."""
+        return tuple(int(c) for c in self.to_list())
+
+    def to_hex(self) -> str:
+        return f"#{self.r:02x}{self.g:02x}{self.b:02x}"
+
+    @classmethod
+    def from_list(cls, rgb_list: list[int | str]) -> "Color":
+        if len(rgb_list) >= 3:
+            return cls(int(rgb_list[0]), int(rgb_list[1]), int(rgb_list[2]))
+        return cls()
+
+    @classmethod
+    def from_hex(cls, hex_color: str) -> "Color":
+        hex_color = hex_color.lstrip("#")
+        if len(hex_color) == 6:
+            return cls(
+                int(hex_color[0:2], 16),
+                int(hex_color[2:4], 16),
+                int(hex_color[4:6], 16),
+            )
+        return cls()
+
+    def __str__(self):
+        return self.to_hex()
+
+    def __repr__(self):
+        return f"Color({self.r}, {self.g}, {self.b})"

config_cli_gui-0.2.9/src/config_cli_gui/configtypes/font.py

@@ -0,0 +1,80 @@
+import os
+from pathlib import Path
+from typing import Any
+
+from PIL import ImageFont
+
+from config_cli_gui.configtypes.color import Color
+
+
+def list_system_fonts() -> list[str]:
+    font_dirs = [
+        "/usr/share/fonts",
+        "/usr/local/share/fonts",
+        str(Path.home() / ".fonts"),
+        "/Library/Fonts",
+        "/System/Library/Fonts",
+        "C:/Windows/Fonts",
+    ]
+
+    fonts: list[str] = []
+    for d in font_dirs:
+        if os.path.isdir(d):
+            for root, _, files in os.walk(d):
+                for f in files:
+                    if f.lower().endswith((".ttf", ".otf")):
+                        fonts.append(os.path.join(root, f))
+    return fonts
+
+
+class Font:
+    """Represents a font with type, size and color."""
+
+    # Klassenattribute nach Klassendefinition setzen
+    font_files = list_system_fonts()
+    font_names = sorted([os.path.basename(f) for f in font_files])
+    font_files_sorted = sorted(font_files, key=os.path.basename)
+
+    def __init__(self, font_type: str, size: float, color: "Color"):
+        self.name = font_type
+        self.size = size
+        self.color = color
+
+    def to_list(self) -> list[Any]:
+        return [self.name, self.size, self.color.to_hex()]
+
+    @classmethod
+    def from_list(cls, font_data: list[Any]) -> "Font":
+        if len(font_data) < 3:
+            return cls("Arial", 12, Color(0, 0, 0))
+
+        font_type, size, color_val = font_data
+        color = (
+            Color.from_hex(color_val) if isinstance(color_val, str) else Color.from_list(color_val)
+        )
+        return cls(str(font_type), float(size), color)
+
+    def get_image_font(self, dpi=25.4) -> ImageFont.FreeTypeFont:
+        """
+        Return a PIL FreeTypeFont, with fallback to default.
+
+        :param dpi: if dpi is provided, the font size is re-calculated on base of the dpi
+        :return:
+        """
+        try:
+            if self.name in self.font_names:
+                idx = self.font_names.index(self.name)
+                path = self.font_files_sorted[idx]
+                size = self.size * dpi / 25.4
+                return ImageFont.truetype(path, size)
+        except Exception as e:
+            print(f"Fehler beim Laden der Schrift '{self.name}': {e}")
+
+        print("Fallback: Nutze Default-Font.")
+        return ImageFont.load_default()
+
+    def __repr__(self) -> str:
+        return f"Font(type='{self.name}', size={self.size}, color={self.color!r})"
+
+    def __str__(self) -> str:
+        return f"{self.name}, {self.size}pt, {self.color}"

config_cli_gui-0.2.9/src/config_cli_gui/configtypes/vector.py

@@ -0,0 +1,31 @@
+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)}"