config-cli-gui 0.1.1__tar.gz → 0.1.2__tar.gz

config_cli_gui-0.1.2/HISTORY.md

@@ -0,0 +1,25 @@
+Changelog
+=========
+
+
+(unreleased)
+------------
+- 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]
+
+

{config_cli_gui-0.1.1 → config_cli_gui-0.1.2}/Makefile

@@ -55,38 +55,6 @@ test: lint        ## Run tests and generate coverage report.
 	uv run coverage xml
 	uv run coverage html
 
-.PHONY: build-win
-build-win:    ## Build the Windows executable.
-	echo "Building unified CLI/GUI application"
-	uv run pyinstaller --onefile src/main.py --name config-cli-gui --add-data "config.yaml;." --hidden-import config_cli_gui.cli.cli --hidden-import config_cli_gui.gui.gui
-	rm -rf release
-	mkdir release
-	cp dist/config-cli-gui.exe release
-	cp config.yaml release
-	cp README.md release
-
-.PHONY: build-macos
-build-macos:    ## Build the macOS executable.
-	echo "Building unified CLI/GUI application as executable"
-	uv run pyinstaller --onefile src/main.py --name config-cli-gui --add-data "config.yaml:." --hidden-import config_cli_gui.cli.cli --hidden-import config_cli_gui.gui.gui
-
-	echo "Building unified CLI/GUI application as .app bundle"
-	# --windowed is important to hide the console for GUI mode
-	# The name "TemplateApp" becomes the name of the .app
-	uv run pyinstaller --windowed --name "TemplateApp" src/main.py --add-data "config.yaml:." --hidden-import config_cli_gui.cli.cli --hidden-import config_cli_gui.gui.gui
-
-	# Prepare ZIP file for release
-	rm -rf release
-	mkdir release
-	echo "Copy the CLI/GUI executable"
-	cp dist/config-cli-gui release/
-	echo "Copy the .app bundle (directory) recursively"
-	cp -R "dist/TemplateApp.app" release/
-	echo "Copy configuration and documentation"
-	cp config.yaml release/
-	cp README.md release/
-	echo "Create usage instructions"
-
 .PHONY: watch
 watch:            ## Run tests on every change.
 	ls **/**.py | entr uv run pytest -s -vvv -l --tb=long --maxfail=1 tests/

{config_cli_gui-0.1.1/src/config_cli_gui.egg-info → config_cli_gui-0.1.2}/PKG-INFO

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

config_cli_gui-0.1.2/config.yaml

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

config_cli_gui-0.1.2/docs/getting-started/install.md

@@ -0,0 +1,28 @@
+# Installation
+
+
+## 🐍 PyPI
+
+### Install the package from PyPI
+
+Download from [PyPI](https://pypi.org/):
+
+```bash
+pip install config-cli-gui
+```
+
+## 👩🏼‍💻 Run from source
+
+### Clone the repository
+
+```bash
+git clone
+```
+
+### Install dependencies
+
+```bash
+uv venv
+uv pip install -e .[dev,docs]
+```
+

{config_cli_gui-0.1.1 → config_cli_gui-0.1.2}/docs/usage/cli.md

@@ -26,19 +26,33 @@ python -m app [OPTIONS] input
 python -m app input
 ```
 
-### 2. With min_dist parameter
+### 2. With verbose logging
+
+```bash
+python -m app -v input
+python -m app --verbose input
+```
+
+### 3. With quiet mode
+
+```bash
+python -m app -q input
+python -m app --quiet input
+```
+
+### 4. With min_dist parameter
 
 ```bash
 python -m app --min_dist 20 input
 ```
 
-### 3. With extract_waypoints parameter
+### 5. With extract_waypoints parameter
 
 ```bash
 python -m app --extract_waypoints True input
 ```
 
-### 4. With elevation parameter
+### 6. With elevation parameter
 
 ```bash
 python -m app --elevation True input

{config_cli_gui-0.1.1 → config_cli_gui-0.1.2}/docs/usage/config.md

@@ -37,3 +37,11 @@ The parameters in the cli category can be accessed via the command line interfac
 | auto_scroll_log   | bool | Automatically scroll to newest log entries | True    | [True, False]             |
 | max_log_lines     | int  | Maximum number of log lines to keep in GUI | 1000    | -                         |
 
+## 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, 23, 18, 58, 52, 946103) | -       |
+

{config_cli_gui-0.1.1 → config_cli_gui-0.1.2}/src/config_cli_gui/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.1.1'
-__version_tuple__ = version_tuple = (0, 1, 1)
+__version__ = version = '0.1.2'
+__version_tuple__ = version_tuple = (0, 1, 2)

{config_cli_gui-0.1.1 → config_cli_gui-0.1.2}/src/config_cli_gui/config_framework.py

@@ -1,6 +1,3 @@
-# config_framework/core.py
-"""Generic configuration framework for Python applications."""
-
 import json
 from abc import ABC, abstractmethod
 from dataclasses import dataclass
@@ -93,7 +90,9 @@ class BaseConfigCategory(BaseModel, ABC):
 class ConfigManager:
     """Generic configuration manager that can handle multiple configuration categories."""
 
-    def __init__(self, config_file: str = None, **kwargs):
+    def __init__(
+        self, categories: tuple[BaseConfigCategory, ...], config_file: str = None, **kwargs
+    ):
         """Initialize configuration manager.
 
         Args:
@@ -102,6 +101,14 @@ class ConfigManager:
         """
         self._categories: dict[str, BaseConfigCategory] = {}
 
+        for category in categories:
+            if isinstance(category, BaseConfigCategory):
+                self.add_category(category.get_category_name(), category)
+            else:
+                raise TypeError(
+                    f"Category must be an instance of BaseConfigCategory, got {type(category)}"
+                )
+
         # Load from file if provided
         if config_file:
             self.load_from_file(config_file)
@@ -146,8 +153,14 @@ class ConfigManager:
             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 config_data.items():
+        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():
@@ -165,7 +178,12 @@ class ConfigManager:
                                 param.default = param_value
 
     def save_to_file(self, config_file: str, format_: str = "auto"):
-        """Save current configuration to file."""
+        """Save current configuration to file with enhanced YAML formatting and comments.
+
+        Args:
+            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()
 
@@ -182,6 +200,10 @@ class ConfigManager:
             else:
                 json.dump(config_data, f, indent=2)
 
+        # Append comments for YAML files
+        if format_ == "yaml":
+            self._append_comments_to_yaml(config_path)
+
     def to_dict(self) -> dict[str, Any]:
         """Convert configuration to dictionary."""
         result = {}
@@ -215,3 +237,45 @@ class ConfigManager:
                 if param.is_cli:
                     cli_parameters.append(param)
         return cli_parameters
+
+    def _append_comments_to_yaml(self, config_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()
+        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.
+            if (
+                stripped_line.endswith(":")
+                and not stripped_line.startswith("#")
+                and line.startswith(stripped_line)
+            ):
+                current_category = stripped_line[:-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
+                    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))
+                            comment = (
+                                f"{comment_indent}# {param.help} | "
+                                f"type={type(param).__name__}, default={param.default}"
+                            )
+                            new_lines.append(comment)
+                new_lines.append(line)
+        config_path.write_text("\n".join(new_lines), encoding="utf-8")

{config_cli_gui-0.1.1 → config_cli_gui-0.1.2}/src/config_cli_gui/docs_generator.py

@@ -70,23 +70,7 @@ class DocumentationGenerator:
         """Generate a default configuration file with all parameters and descriptions."""
         output_path = Path(output_file)
         output_path.parent.mkdir(parents=True, exist_ok=True)
-
-        with open(output_path, "w", encoding="utf-8") as f:
-            f.write("# Configuration File\n")
-            f.write("# This file was auto-generated. Modify as needed.\n\n")
-
-            for category_name, category in self.config_manager._categories.items():
-                f.write(f"# {category_name.upper()} Configuration\n")
-                f.write(f"{category_name}:\n")
-
-                for param in category.get_parameters():
-                    f.write(f"  # {param.help}\n")
-                    if param.choices:
-                        f.write(f"  # Choices: {param.choices}\n")
-                    f.write(f"  # Type: {type(param.default).__name__}\n")
-                    f.write(f"  {param.name}: {repr(param.default)}\n\n")
-
-                f.write("\n")
+        self.config_manager.save_to_file(output_path.as_posix())
 
     def generate_cli_markdown_doc(self, output_file: str, app_name: str = "app"):
         """Generate Markdown CLI documentation."""
@@ -150,8 +134,35 @@ class DocumentationGenerator:
             )
         )
 
+        # Add logging examples
+        examples.append(
+            dedent(
+                f"""
+        ### 2. With verbose logging
+
+        ```bash
+        python -m {app_name} -v {required_arg}
+        python -m {app_name} --verbose {required_arg}
+        ```
+        """
+            )
+        )
+
+        examples.append(
+            dedent(
+                f"""
+        ### 3. With quiet mode
+
+        ```bash
+        python -m {app_name} -q {required_arg}
+        python -m {app_name} --quiet {required_arg}
+        ```
+        """
+            )
+        )
+
         # Add more examples with optional parameters
-        for i, param in enumerate(optional_params[:3], 2):
+        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

{config_cli_gui-0.1.1 → config_cli_gui-0.1.2}/src/config_cli_gui/gui_generator.py

@@ -82,48 +82,44 @@ class CalendarDialog:
         main_frame = ttk.Frame(self.dialog)
         main_frame.pack(fill=tk.BOTH, expand=True, padx=10, pady=10)
 
-        # Year selection
-        year_frame = ttk.Frame(main_frame)
-        year_frame.pack(fill=tk.X, pady=(0, 5))
+        # Date selection in a single row
+        date_label_frame = ttk.Frame(main_frame)
+        date_label_frame.pack(fill=tk.X, pady=(0, 2))
+
+        ttk.Label(date_label_frame, text="Year:").pack(side=tk.LEFT, expand=True)
+        ttk.Label(date_label_frame, text="Month:").pack(side=tk.LEFT, expand=True)
+        ttk.Label(date_label_frame, text="Day:").pack(side=tk.LEFT, expand=True)
+
+        date_input_frame = ttk.Frame(main_frame)
+        date_input_frame.pack(fill=tk.X, pady=(0, 10))
 
-        ttk.Label(year_frame, text="Year:").pack(side=tk.LEFT)
         self.year_var = tk.IntVar(value=self.initial_date.year)
         year_spinbox = ttk.Spinbox(
-            year_frame,
+            date_input_frame,
             from_=1900,
             to=2100,
             textvariable=self.year_var,
             command=self._update_calendar,
-            width=10,
+            width=8,
         )
-        year_spinbox.pack(side=tk.LEFT, padx=(5, 0))
+        year_spinbox.pack(side=tk.LEFT, expand=True, padx=(0, 5))
 
-        # Month selection
-        month_frame = ttk.Frame(main_frame)
-        month_frame.pack(fill=tk.X, pady=(0, 5))
-
-        ttk.Label(month_frame, text="Month:").pack(side=tk.LEFT)
         self.month_var = tk.IntVar(value=self.initial_date.month)
         month_combo = ttk.Combobox(
-            month_frame,
+            date_input_frame,
             textvariable=self.month_var,
             values=list(range(1, 13)),
             state="readonly",
             width=8,
         )
-        month_combo.pack(side=tk.LEFT, padx=(5, 0))
+        month_combo.pack(side=tk.LEFT, expand=True, padx=(0, 5))
         month_combo.bind("<<ComboboxSelected>>", lambda e: self._update_calendar())
 
-        # Day selection
-        day_frame = ttk.Frame(main_frame)
-        day_frame.pack(fill=tk.X, pady=(0, 5))
-
-        ttk.Label(day_frame, text="Day:").pack(side=tk.LEFT)
         self.day_var = tk.IntVar(value=self.initial_date.day)
         self.day_spinbox = ttk.Spinbox(
-            day_frame, from_=1, to=31, textvariable=self.day_var, width=8
+            date_input_frame, from_=1, to=31, textvariable=self.day_var, width=8
         )
-        self.day_spinbox.pack(side=tk.LEFT, padx=(5, 0))
+        self.day_spinbox.pack(side=tk.LEFT, expand=True)
 
         # Time selection
         time_frame = ttk.Frame(main_frame)
@@ -247,7 +243,7 @@ class GenericSettingsDialog:
         """Create a tab for a configuration category."""
         # Create tab frame
         tab_frame = ttk.Frame(self.notebook)
-        self.notebook.add(tab_frame, text=category_name.title())
+        self.notebook.add(tab_frame, text="  " + category_name.title() + "  ")
 
         # Create scrollable frame
         canvas = tk.Canvas(tab_frame)
@@ -302,29 +298,27 @@ class GenericSettingsDialog:
 
     def _create_parameter_widget(self, parent, param: ConfigParameter):
         """Create appropriate widget for parameter type."""
-        param_type = type(param.default)
-
         # Boolean type - Checkbox
-        if param_type == bool:
+        if isinstance(param.default, bool):
             var = tk.BooleanVar(value=param.default)
             widget = ttk.Checkbutton(parent, variable=var)
             widget.var = var
             return widget
 
         # Path type - File/Directory selector
-        elif param_type == Path:
+        elif isinstance(param.default, Path):
             return self._create_path_widget(parent, param)
 
         # Color type - Color picker
-        elif param_type == Color:
+        elif isinstance(param.default, Color):
             return self._create_color_widget(parent, param)
 
         # DateTime type - DateTime picker
-        elif param_type == datetime:
+        elif isinstance(param.default, datetime):
             return self._create_datetime_widget(parent, param)
 
         # List/Tuple with choices - Combobox
-        elif param.choices and param_type != bool:
+        elif param.choices and not isinstance(param.default, bool):
             var = tk.StringVar(value=str(param.default))
             widget = ttk.Combobox(
                 parent, textvariable=var, values=list(param.choices), state="readonly"
@@ -333,22 +327,22 @@ class GenericSettingsDialog:
             return widget
 
         # List/Tuple type - Multi-entry widget
-        elif param_type in (list, tuple):
+        elif isinstance(param.default, list) or isinstance(param.default, tuple):
             return self._create_list_widget(parent, param)
 
         # Dict type - Key-Value editor
-        elif param_type == dict:
+        elif isinstance(param.default, dict):
             return self._create_dict_widget(parent, param)
 
         # Integer type - Spinbox
-        elif param_type == int:
+        elif isinstance(param.default, int):
             var = tk.IntVar(value=param.default)
             widget = ttk.Spinbox(parent, from_=-999999, to=999999, textvariable=var)
             widget.var = var
             return widget
 
         # Float type - Spinbox
-        elif param_type == float:
+        elif isinstance(param.default, float):
             var = tk.DoubleVar(value=param.default)
             widget = ttk.Spinbox(
                 parent, from_=-999999.0, to=999999.0, increment=1.0, textvariable=var
@@ -396,7 +390,7 @@ class GenericSettingsDialog:
         entry = ttk.Entry(frame, textvariable=var, width=10)
         entry.pack(side=tk.LEFT)
 
-        color_display = tk.Label(frame, width=3, bg=color_value.to_hex())
+        color_display = tk.Label(frame, width=7, bg=color_value.to_hex())
         color_display.pack(side=tk.LEFT, padx=(5, 0))
 
         def pick_color():

{config_cli_gui-0.1.1 → config_cli_gui-0.1.2/src/config_cli_gui.egg-info}/PKG-INFO

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

{config_cli_gui-0.1.1 → config_cli_gui-0.1.2}/src/config_cli_gui.egg-info/SOURCES.txt

@@ -19,13 +19,10 @@ uv.lock
 .github/ISSUE_TEMPLATE/bug_report.md
 .github/ISSUE_TEMPLATE/feature_request.md
 .github/actions/setup-environment/action.yml
-.github/workflows/build-macos.yml
-.github/workflows/build.yml
 .github/workflows/main.yml
 .github/workflows/release.yml
 .github/workflows/update_readme.yml
 .idea/runConfigurations/config_generate.xml
-.idea/runConfigurations/module_gui.xml
 docs/.nav.yml
 docs/index.md
 docs/_static/img/favicon.png
@@ -34,7 +31,6 @@ docs/css/custom.css
 docs/develop/contributing.md
 docs/develop/make_windows.md
 docs/develop/naming_convention.md
-docs/develop/pypi_release.md
 docs/funding/funding.md
 docs/getting-started/install.md
 docs/getting-started/virtual-environment.md

{config_cli_gui-0.1.1 → config_cli_gui-0.1.2}/tests/example_project/config/config.py

@@ -5,8 +5,12 @@ organized in categories (CLI, App, GUI). It can generate config files, CLI modul
 and documentation from the parameter definitions.
 """
 
+from datetime import datetime
+from pathlib import Path
+
 from config_cli_gui.config_framework import (
     BaseConfigCategory,
+    Color,
     ConfigManager,
     ConfigParameter,
 )
@@ -159,17 +163,37 @@ class GuiConfig(BaseConfigCategory):
     )
 
 
+class MiscConfig(BaseConfigCategory):
+    def get_category_name(self) -> str:
+        return "misc"
+
+    some_file: ConfigParameter = ConfigParameter(
+        name="some_file",
+        default=Path("some_file.txt"),
+        help="Path to the file to use",
+    )
+
+    some_color: ConfigParameter = ConfigParameter(
+        name="some_color",
+        default=Color(255, 0, 0),
+        help="Color setting for the application",
+    )
+
+    some_date: ConfigParameter = ConfigParameter(
+        name="some_date",
+        default=datetime.now(),
+        help="Date setting for the application",
+    )
+
+
 class ConfigParameterManager(ConfigManager):  # Inherit from ConfigManager
     """Main configuration manager that handles all parameter categories."""
 
-    def __init__(self, config_file: str | None = None, **kwargs):
-        # Erst den Parent initialisieren
-        super().__init__(config_file, **kwargs)
+    categories = (CliConfig(), AppConfig(), GuiConfig(), MiscConfig())
 
-        # Dann die Kategorien hinzufügen
-        self.add_category("cli", CliConfig())
-        self.add_category("app", AppConfig())
-        self.add_category("gui", GuiConfig())
+    def __init__(self, config_file: str | None = None, **kwargs):
+        """Initialize the configuration manager with all parameter categories."""
+        super().__init__(self.categories, config_file, **kwargs)
 
 
 def main():

{config_cli_gui-0.1.1 → config_cli_gui-0.1.2}/tests/test_generic_cli.py

@@ -79,7 +79,7 @@ class TestGenericCLI(unittest.TestCase):
 
         # Check file content
         content = output_file.read_text()
-        self.assertIn("# Configuration File", content)
+        self.assertIn("# Include elevation data in waypoints", content)
 
         for param in self.default_cli_config.keys():
             with self.subTest(parameter=param):