python-template-project 0.2.2__tar.gz → 0.2.3__tar.gz

{python_template_project-0.2.2 → python_template_project-0.2.3}/.idea/runConfigurations/config_generate.xml

@@ -8,16 +8,16 @@
       <env name="PYTHONUNBUFFERED" value="1" />
     </envs>
     <option name="SDK_HOME" value="" />
-    <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$/src/python_template_project" />
+    <option name="WORKING_DIRECTORY" value="$ProjectFileDir$" />
     <option name="IS_MODULE_SDK" value="true" />
     <option name="ADD_CONTENT_ROOTS" value="true" />
     <option name="ADD_SOURCE_ROOTS" value="true" />
     <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
-    <option name="SCRIPT_NAME" value="$PROJECT_DIR$/src/python_template_project/config/config.py" />
+    <option name="SCRIPT_NAME" value="python_template_project.config.config" />
     <option name="PARAMETERS" value="" />
     <option name="SHOW_COMMAND_LINE" value="false" />
     <option name="EMULATE_TERMINAL" value="false" />
-    <option name="MODULE_MODE" value="false" />
+    <option name="MODULE_MODE" value="true" />
     <option name="REDIRECT_INPUT" value="false" />
     <option name="INPUT_FILE" value="" />
     <method v="2" />

{python_template_project-0.2.2 → python_template_project-0.2.3}/.idea/runConfigurations/module_cli.xml

@@ -8,7 +8,7 @@
       <env name="PYTHONUNBUFFERED" value="1" />
     </envs>
     <option name="SDK_HOME" value="" />
-    <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$" />
+    <option name="WORKING_DIRECTORY" value="$ProjectFileDir$" />
     <option name="IS_MODULE_SDK" value="true" />
     <option name="ADD_CONTENT_ROOTS" value="true" />
     <option name="ADD_SOURCE_ROOTS" value="true" />

{python_template_project-0.2.2 → python_template_project-0.2.3}/.idea/runConfigurations/module_gui.xml

@@ -8,7 +8,7 @@
       <env name="PYTHONUNBUFFERED" value="1" />
     </envs>
     <option name="SDK_HOME" value="" />
-    <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$" />
+    <option name="WORKING_DIRECTORY" value="$ProjectFileDir$" />
     <option name="IS_MODULE_SDK" value="true" />
     <option name="ADD_CONTENT_ROOTS" value="true" />
     <option name="ADD_SOURCE_ROOTS" value="true" />

{python_template_project-0.2.2 → python_template_project-0.2.3}/HISTORY.md

@@ -4,6 +4,15 @@ Changelog
 
 (unreleased)
 ------------
+- Run precommit before building release for proper formatting. [Paul
+  Magister]
+- Valid app_name for cli configuration. [Paul Magister]
+- Proper run configurations. [Paul Magister]
+
+
+0.2.2 (2025-11-14)
+------------------
+- Docs: Update HISTORY.md for release 0.2.2. [Paul Magister]
 - Improved cli example, fix elevation cli param problem. [Paul Magister]
 - Update to new config: cli fixes. [Paul Magister]
 

{python_template_project-0.2.2 → python_template_project-0.2.3}/Makefile

@@ -119,6 +119,7 @@ virtualenv:       ## Create a virtual environment.
 
 .PHONY: release
 release:          ## Create a new tag for release.
+	$(MAKE) precommit
 	@echo "WARNING: This operation will create a version tag and push to GitHub"
 
 	# Get the latest Git tag if it exists, otherwise default to 0.0.0 for calculations

{python_template_project-0.2.2/src/python_template_project.egg-info → python_template_project-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-template-project
-Version: 0.2.2
+Version: 0.2.3
 Summary: Feature-rich Python project template designed for robustness and ease of use.
 Author: pamagister
 Requires-Python: <3.12,>=3.10

{python_template_project-0.2.2 → python_template_project-0.2.3}/config.yaml

@@ -22,12 +22,12 @@ 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
+  # Maximum distance between two waypoints | type=int, default=25 [CLI]
+  min_dist: 25
   # Path to output destination | type=str, default= [CLI]
   output: ''
 gui:
-  # Automatically scroll to newest log entries | type=bool, default=True
+  # 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

{python_template_project-0.2.2 → python_template_project-0.2.3}/docs/usage/cli.md

@@ -1,9 +1,9 @@
 # Command Line Interface
 
-Command line options for app
+Command line options for python_template_project
 
 ```bash
-python -m app [OPTIONS] input
+python -m python_template_project [OPTIONS] input
 ```
 
 ## Options
@@ -12,7 +12,7 @@ python -m app [OPTIONS] input
 |-----------------------|------|---------------------------------------------------|------------|---------------|
 | `input`               | str  | Path to input (file or folder)                    | *required* | -             |
 | `--output`            | str  | Path to output destination                        | *required* | -             |
-| `--min_dist`          | int  | Maximum distance between two waypoints            | 20         | -             |
+| `--min_dist`          | int  | Maximum distance between two waypoints            | 25         | -             |
 | `--extract_waypoints` | bool | Extract starting points of each track as waypoint | True       | [True, False] |
 | `--elevation`         | bool | Include elevation data in waypoints               | True       | [True, False] |
 
@@ -23,37 +23,37 @@ python -m app [OPTIONS] input
 ### 1. Basic usage
 
 ```bash
-python -m app input
+python -m python_template_project input
 ```
 
 ### 2. With verbose logging
 
 ```bash
-python -m app -v input
-python -m app --verbose input
+python -m python_template_project -v input
+python -m python_template_project --verbose input
 ```
 
 ### 3. With quiet mode
 
 ```bash
-python -m app -q input
-python -m app --quiet input
+python -m python_template_project -q input
+python -m python_template_project --quiet input
 ```
 
 ### 4. With min_dist parameter
 
 ```bash
-python -m app --min_dist 20 input
+python -m python_template_project --min_dist 25 input
 ```
 
 ### 5. With extract_waypoints parameter
 
 ```bash
-python -m app --extract_waypoints True input
+python -m python_template_project --extract_waypoints True input
 ```
 
 ### 6. With elevation parameter
 
 ```bash
-python -m app --elevation True input
+python -m python_template_project --elevation True input
 ```

{python_template_project-0.2.2 → python_template_project-0.2.3}/docs/usage/config.md

@@ -9,7 +9,7 @@ The parameters in the cli category can be accessed via the command line interfac
 |-------------------|------|---------------------------------------------------|---------|---------------|
 | input             | str  | Path to input (file or folder)                    | ''      | -             |
 | output            | str  | Path to output destination                        | ''      | -             |
-| min_dist          | int  | Maximum distance between two waypoints            | 20      | -             |
+| min_dist          | int  | Maximum distance between two waypoints            | 25      | -             |
 | extract_waypoints | bool | Extract starting points of each track as waypoint | True    | [True, False] |
 | elevation         | bool | Include elevation data in waypoints               | True    | [True, False] |
 
@@ -28,12 +28,12 @@ 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    | -                         |
 

{python_template_project-0.2.2 → python_template_project-0.2.3}/src/python_template_project/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.2.2'
-__version_tuple__ = version_tuple = (0, 2, 2)
+__version__ = version = '0.2.3'
+__version_tuple__ = version_tuple = (0, 2, 3)
 
-__commit_id__ = commit_id = 'g43e51a5fe'
+__commit_id__ = commit_id = 'g05d198f46'

{python_template_project-0.2.2 → python_template_project-0.2.3}/src/python_template_project/config/config.py

@@ -34,7 +34,7 @@ class CliConfig(ConfigCategory):
 
     min_dist: ConfigParameter = ConfigParameter(
         name="min_dist",
-        value=20,
+        value=25,
         help="Maximum distance between two waypoints",
         is_cli=True,
     )
@@ -145,7 +145,7 @@ class GuiConfig(ConfigCategory):
     auto_scroll_log: ConfigParameter = ConfigParameter(
         name="auto_scroll_log",
         value=True,
-        help="Automatically scroll to newest log entries",
+        help="Automatically scroll to the newest log entries",
     )
 
     max_log_lines: ConfigParameter = ConfigParameter(
@@ -170,9 +170,10 @@ class ConfigParameterManager(ConfigManager):  # Inherit from ConfigManager
 
 def main():
     """Main function to generate config file and documentation."""
-    default_config: str = "../../config.yaml"
-    default_cli_doc: str = "../../docs/usage/cli.md"
-    default_config_doc: str = "../../docs/usage/config.md"
+    default_config: str = "config.yaml"
+    default_cli_doc: str = "docs/usage/cli.md"
+    default_config_doc: str = "docs/usage/config.md"
+    app_name = "python_template_project"
     config_manager = ConfigParameterManager()
     doc_gen = DocumentationGenerator(config_manager)
     doc_gen.generate_default_config_file(output_file=default_config)
@@ -181,7 +182,7 @@ def main():
     doc_gen.generate_config_markdown_doc(output_file=default_config_doc)
     print(f"Generated: {default_config_doc}")
 
-    doc_gen.generate_cli_markdown_doc(output_file=default_cli_doc)
+    doc_gen.generate_cli_markdown_doc(output_file=default_cli_doc, app_name=app_name)
     print(f"Generated: {default_cli_doc}")
 
 

{python_template_project-0.2.2 → python_template_project-0.2.3/src/python_template_project.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-template-project
-Version: 0.2.2
+Version: 0.2.3
 Summary: Feature-rich Python project template designed for robustness and ease of use.
 Author: pamagister
 Requires-Python: <3.12,>=3.10