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

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

@@ -4,6 +4,14 @@ 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]
@@ -24,8 +32,8 @@ Changelog
 - 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.py * separate
-  module for docs.py. [Paul Magister]
+  remove type_ * add improved widgets to gui_generator.py * separate
+  module for docs_generator.py. [Paul Magister]
 
 
 0.1.0 (2025-06-22)

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: config-cli-gui
-Version: 0.1.3
+Version: 0.1.4
 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.yaml

@@ -0,0 +1,51 @@
+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=True [CLI]
+  elevation: true
+  # 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:
+  - 255
+  - 0
+  - 0
+  # Date setting for the application | type=datetime, default=2025-06-24 00:19:57.095774
+  some_date: '2025-06-24T00:19:57.095774'
+  # Path to the file to use | type=WindowsPath, default=some_file.txt
+  some_file: some_file.txt

{config_cli_gui-0.1.3 → config_cli_gui-0.1.4}/docs/usage/config.md

@@ -28,20 +28,20 @@ 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 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    | -                         |
 
 ## 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) | -       |
+| 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) | -       |
 

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

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.1.3'
-__version_tuple__ = version_tuple = (0, 1, 3)
+__version__ = version = '0.1.4'
+__version_tuple__ = version_tuple = (0, 1, 4)

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

@@ -272,7 +272,8 @@ class ConfigManager:
                             comment_indent = " " * (len(line) - len(stripped_line))
                             comment = (
                                 f"{comment_indent}# {param.help} | "
-                                f"type={type(param).__name__}, default={param.default}"
+                                f"type={type(param.default).__name__}, default={param.default}"
+                                f"{' [CLI]' if param.is_cli else ''}"
                             )
                             new_lines.append(comment)
                 new_lines.append(line)

{config_cli_gui-0.1.3 → config_cli_gui-0.1.4}/src/config_cli_gui.egg-info/PKG-INFO

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

{config_cli_gui-0.1.3 → config_cli_gui-0.1.4}/src/config_cli_gui.egg-info/SOURCES.txt

@@ -36,9 +36,6 @@ docs/getting-started/install.md
 docs/getting-started/virtual-environment.md
 docs/usage/cli.md
 docs/usage/config.md
-examples/kuhkopfsteig.gpx
-examples/rother_lilienstein.gpx
-examples/teneriffa.gpx
 scripts/show_filelist.ps1
 scripts/show_tree.ps1
 scripts/show_tree.py

{config_cli_gui-0.1.3 → config_cli_gui-0.1.4}/tests/example_project/config/config_example.py

@@ -153,7 +153,7 @@ class GuiConfig(ConfigCategory):
     auto_scroll_log: ConfigParameter = ConfigParameter(
         name="auto_scroll_log",
         default=True,
-        help="Automatically scroll to newest log entries",
+        help="Automatically scroll to the newest log entries",
     )
 
     max_log_lines: ConfigParameter = ConfigParameter(

config_cli_gui-0.1.3/config.yaml

@@ -1,51 +0,0 @@
-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:00
-  some_date: '2025-06-23T18:58:00'
-  # Path to the file to use | type=ConfigParameter, default=some_file.txt
-  some_file: some_file.txt