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

python_template_project-0.2.5/.github/workflows/build-linux.yml

@@ -0,0 +1,48 @@
+name: Build Linux App
+
+on:
+  push:
+    tags:
+      - '*'
+  workflow_dispatch:
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [ 3.11 ]
+        os: [ ubuntu-latest ]
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Setup Environment
+        uses: ./.github/actions/setup-environment
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Build Unified Linux Executable with PyInstaller
+        run: |
+          make build-linux
+
+      - name: Prepare ZIP file for release
+        run: |
+          echo "Create the ZIP archive from the contents of the release folder"
+          cd release
+          zip -r ../package-linux.zip .
+
+      - name: Upload ZIP to GitHub Release
+        uses: softprops/action-gh-release@v2
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          files: package-linux.zip
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

{python_template_project-0.2.3 → python_template_project-0.2.5}/.readthedocs.yaml

@@ -11,9 +11,9 @@ build:
 
 python:
   install:
-    - method: pip
-      path: .
-      extra_requirements:
+    - method: uv
+      command: sync
+      groups:
         - docs
 
 mkdocs:

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

@@ -4,6 +4,35 @@ Changelog
 
 (unreleased)
 ------------
+- Ich habe .readthedocs.yaml auf Read the Docs’ uv-Integration mit der
+  Gruppe docs umgestellt. Hinweis: uv sync wählt standardmäßig auch die
+  dev-Gruppe aus. [Paul Magister]
+- Updated pyproject.toml to remove Deptry’s deprecated setting, which
+  pointed at optional-dependency groups that this project doesn’t use.
+  Added a targeted exception for lxml, an intentional dependency that
+  Deptry otherwise flags as unused. [Paul Magister]
+- Bump version of config-cli-gui to latest version. [Paul Magister]
+- Improve makefile. [Paul Magister]
+
+
+0.2.4 (2025-11-30)
+------------------
+- Docs: Update HISTORY.md for release 0.2.4. [Paul Magister]
+- Add linux build workflow. [Paul Magister]
+- Avoid warning by adding lxml package. [Paul Magister]
+- Fix format. [Paul Magister]
+- Only use on py file to show tree with or without python classes. [Paul
+  Magister]
+- Switch to python scripts that print the project structure. [Paul
+  Magister]
+- Switch to pytest. [Paul Magister]
+- Update README.md from docs/index.md. [github-actions]
+- Typo with with. [Paul Magister]
+
+
+0.2.3 (2025-11-14)
+------------------
+- Docs: Update HISTORY.md for release 0.2.3. [Paul Magister]
 - Run precommit before building release for proper formatting. [Paul
   Magister]
 - Valid app_name for cli configuration. [Paul Magister]

{python_template_project-0.2.3 → python_template_project-0.2.5}/Makefile

@@ -18,8 +18,7 @@ show:             ## Show the current environment.
 .PHONY: install
 install:          ## Install the project in dev mode.
 	$(MAKE) lock
-	$(MAKE) virtualenv
-	uv pip install -e .[dev,docs]
+	uv sync --all-groups
 
 .PHONY: lock
 lock:           ## builds the uv.make lock file and syncs the packages
@@ -40,6 +39,7 @@ fmt:              ## Format code using black & isort.
 	uv run ruff format tests/
 	uv run ruff check src/ --fix
 	uv run ruff check tests/ --fix
+	$(MAKE) syncdocs
 
 .PHONY: lint
 lint:             ## Run pep8, black, mypy linters.
@@ -65,6 +65,18 @@ build-win:    ## Build the Windows executable.
 	cp config.yaml release
 	cp README.md release
 
+.PHONY: build-linux
+build-linux:    ## Build the Linux executable.
+	## Build the Linux executable.
+	uv run pyinstaller --onefile src/main.py --name python-template-project --add-data "config.yaml;." --hidden-import python_template_project.cli.cli --hidden-import python_template_project.gui.gui
+
+	rm -rf release
+	mkdir release
+	cp dist/python-template-project 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"
@@ -147,27 +159,28 @@ release:          ## Create a new tag for release.
 	echo "GitHub Actions will detect the new tag and trigger the release workflows."
 	echo "Add modified files to commit and push them to main"
 
-.PHONY: docs
-docs:             ## Build and sync the documentation.
+.PHONY: syncdocs
+syncdocs:         ## Sync the documentation.
 	@echo "sync documentation ..."
 	@uv run ./scripts/generate_config_docs.py
 	@uv run ./scripts/update_readme.py
 	@uv run ./.github/update_funding.py
-	@echo "building documentation ..."
-	@uv run mkdocs build
-	@uv run mkdocs serve
 
-.PHONY: list
-list:            ## Show project file list (excluding ignored folders)
-	@powershell -NoProfile -ExecutionPolicy Bypass -File ./scripts/show_filelist.ps1
+.PHONY: docs
+docs:             ## Build and sync the documentation.
+	## run syncdocs
+	$(MAKE) syncdocs
+	@echo "building documentation ..."
+	@uv run --group docs mkdocs build
+	@uv run --group docs mkdocs serve
 
 .PHONY: tree
 tree:            ## Show project tree (excluding ignored folders)
-	@powershell -NoProfile -ExecutionPolicy Bypass -File ./scripts/show_tree.ps1
+	@uv run ./scripts/show_tree.py
 
 .PHONY: pytree
 pytree:            ## Show project tree (excluding ignored folders)
-	@uv run ./scripts/show_tree.py
+	@uv run ./scripts/show_tree.py --show-code
 
 .PHONY: init
 init:             ## Initialize the project based on an application template.

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

@@ -1,38 +1,22 @@
 Metadata-Version: 2.4
 Name: python-template-project
-Version: 0.2.3
+Version: 0.2.5
 Summary: Feature-rich Python project template designed for robustness and ease of use.
 Author: pamagister
 Requires-Python: <3.12,>=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: config-cli-gui>=0.2.2
+Requires-Dist: config-cli-gui>=0.3.9
 Requires-Dist: fastkml>=1.1.0
 Requires-Dist: gpxpy>=1.6.2
+Requires-Dist: lxml>=6.0.2
 Requires-Dist: shapely>=2.1.1
 Requires-Dist: srtm-py>=0.3.7
-Provides-Extra: dev
-Requires-Dist: pytest>=8.4.0; extra == "dev"
-Requires-Dist: pytest-mock>=3.14.1; extra == "dev"
-Requires-Dist: coverage>=7.8.2; extra == "dev"
-Requires-Dist: flake8>=7.2.0; extra == "dev"
-Requires-Dist: black>=25.1.0; extra == "dev"
-Requires-Dist: isort>=6.0.1; extra == "dev"
-Requires-Dist: pytest-cov>=6.1.1; extra == "dev"
-Requires-Dist: mypy>=1.16.0; extra == "dev"
-Requires-Dist: gitchangelog>=3.0.4; extra == "dev"
-Requires-Dist: pyinstaller>=5.8; extra == "dev"
-Requires-Dist: pre-commit>=4.2.0; extra == "dev"
-Requires-Dist: ruff>=0.11.13; extra == "dev"
-Provides-Extra: docs
-Requires-Dist: mkdocs>=1.6.1; extra == "docs"
-Requires-Dist: mkdocs-awesome-nav>=2.6.1; extra == "docs"
-Requires-Dist: pygments>=2.19.1; extra == "docs"
 Dynamic: license-file
 
 # Welcome to python-template-project
 
-A feature-rich Python project template with with auto-generated CLI, GUI and parameterized configuration.
+A feature-rich Python project template with auto-generated CLI, GUI and parameterized configuration.
 
 [![Github CI Status](https://github.com/pamagister/python-template-project/actions/workflows/main.yml/badge.svg)](https://github.com/pamagister/python-template-project/actions)
 [![GitHub release](https://img.shields.io/github/v/release/pamagister/python-template-project)](https://github.com/pamagister/python-template-project/releases)

{python_template_project-0.2.3 → python_template_project-0.2.5}/README.md

@@ -2,7 +2,7 @@
 
 # Welcome to python-template-project
 
-A feature-rich Python project template with with auto-generated CLI, GUI and parameterized configuration.
+A feature-rich Python project template with auto-generated CLI, GUI and parameterized configuration.
 
 [![Github CI Status](https://github.com/pamagister/python-template-project/actions/workflows/main.yml/badge.svg)](https://github.com/pamagister/python-template-project/actions)
 [![GitHub release](https://img.shields.io/github/v/release/pamagister/python-template-project)](https://github.com/pamagister/python-template-project/releases)
@@ -51,22 +51,7 @@ Getting started on developing your own project based on this template
 7. **Open the project in your IDE**
 
 8. **Install dependencies and create virtual environment**
-
-   Install uv first:
-   ```bash
-   pip install uv
-   ```
-   
-   On Linux, install pipx first:  
-   ```bash
-   sudo apt install pipx
-   pipx ensurepath
-   ```
-   
-   then, intall uv
-   ```bash
-   pipx install uv
-   ```
+   Run:
 
    ```bash
    make install

python_template_project-0.2.5/config.yaml

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

{python_template_project-0.2.3 → python_template_project-0.2.5}/docs/index.md

@@ -1,6 +1,6 @@
 # Welcome to python-template-project
 
-A feature-rich Python project template with with auto-generated CLI, GUI and parameterized configuration.
+A feature-rich Python project template with auto-generated CLI, GUI and parameterized configuration.
 
 [![Github CI Status](https://github.com/pamagister/python-template-project/actions/workflows/main.yml/badge.svg)](https://github.com/pamagister/python-template-project/actions)
 [![GitHub release](https://img.shields.io/github/v/release/pamagister/python-template-project)](https://github.com/pamagister/python-template-project/releases)

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

@@ -3,13 +3,22 @@
 Command line options for python_template_project
 
 ```bash
-python -m python_template_project [OPTIONS] input
+python-template-project [OPTIONS] <input>
+```
+
+For development from a source checkout, the equivalent module invocation is:
+
+```bash
+python -m python_template_project [OPTIONS] <input>
 ```
 
 ## Options
 
 | Option                | Type | Description                                       | Default    | Choices       |
 |-----------------------|------|---------------------------------------------------|------------|---------------|
+| --config              | str  | Path to configuration file                        | -          | -             |
+| -v, --verbose         | bool | Enable debug logging                              | False      | [True, False] |
+| -q, --quiet           | bool | Show warnings and errors only                     | False      | [True, False] |
 | `input`               | str  | Path to input (file or folder)                    | *required* | -             |
 | `--output`            | str  | Path to output destination                        | *required* | -             |
 | `--min_dist`          | int  | Maximum distance between two waypoints            | 25         | -             |
@@ -23,37 +32,44 @@ python -m python_template_project [OPTIONS] input
 ### 1. Basic usage
 
 ```bash
-python -m python_template_project input
+python-template-project input
 ```
 
 ### 2. With verbose logging
 
 ```bash
-python -m python_template_project -v input
-python -m python_template_project --verbose input
+python-template-project -v input
+python-template-project --verbose input
 ```
 
 ### 3. With quiet mode
 
 ```bash
-python -m python_template_project -q input
-python -m python_template_project --quiet input
+python-template-project -q input
+python-template-project --quiet input
 ```
 
-### 4. With min_dist parameter
+### 4. With output parameter
 
 ```bash
-python -m python_template_project --min_dist 25 input
+python-template-project --output  input
 ```
 
-### 5. With extract_waypoints parameter
+### 5. With min_dist parameter
 
 ```bash
-python -m python_template_project --extract_waypoints True input
+python-template-project --min_dist 25 input
 ```
 
-### 6. With elevation parameter
+### 6. With extract_waypoints parameter
 
 ```bash
-python -m python_template_project --elevation True input
+python-template-project --extract_waypoints True input
+```
+
+### Developer usage
+
+```bash
+python -m python_template_project --help
+python -m python_template_project input
 ```

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

@@ -3,17 +3,16 @@
 These parameters are available to configure the behavior of your application.
 The parameters in the cli category can be accessed via the command line interface.
 
-## Category "cli"
+## Configuration File Reference
 
-| Name              | Type | Description                                       | Default | Choices       |
-|-------------------|------|---------------------------------------------------|---------|---------------|
-| input             | str  | Path to input (file or folder)                    | ''      | -             |
-| output            | str  | Path to output destination                        | ''      | -             |
-| 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] |
+The actual configuration is stored in [`config.yaml`](../../config.yaml). You can:
 
-## Category "app"
+- Edit the configuration file directly using your text editor
+- Use the `--config` command-line option to specify a custom config file
+- Place a `config.yaml` in your application's config
+  directory (typically `~/.config/config-cli-gui/`)
+
+## Category "app" {#app}
 
 | Name                   | Type | Description                                 | Default    | Choices                                           |
 |------------------------|------|---------------------------------------------|------------|---------------------------------------------------|
@@ -26,7 +25,17 @@ The parameters in the cli category can be accessed via the command line interfac
 | enable_file_logging    | bool | Enable logging to file                      | True       | [True, False]                                     |
 | enable_console_logging | bool | Enable logging to console                   | True       | [True, False]                                     |
 
-## Category "gui"
+## Category "cli" {#cli}
+
+| Name              | Type | Description                                       | Default | Choices       |
+|-------------------|------|---------------------------------------------------|---------|---------------|
+| input             | str  | Path to input (file or folder)                    | ''      | -             |
+| output            | str  | Path to output destination                        | ''      | -             |
+| 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] |
+
+## Category "gui" {#gui}
 
 | Name              | Type | Description                                    | Default | Choices                   |
 |-------------------|------|------------------------------------------------|---------|---------------------------|

{python_template_project-0.2.3 → python_template_project-0.2.5}/mkdocs.yml

@@ -1,6 +1,6 @@
 site_name: python-template-project
 site_url: !ENV READTHEDOCS_CANONICAL_URL
-site_description: A feature-rich Python project template with with auto-generated CLI, GUI and parameterized configuration.
+site_description: A feature-rich Python project template with auto-generated CLI, GUI and parameterized configuration.
 repo_url: https://github.com/pamagister/python-template-project
 repo_name: GitHub
 

{python_template_project-0.2.3 → python_template_project-0.2.5}/pyproject.toml

@@ -8,15 +8,15 @@ authors = [
 readme = "docs/index.md"
 requires-python = ">=3.10,<3.12"
 dependencies = [
-    "config-cli-gui>=0.2.2",
+    "config-cli-gui>=0.3.9",
     "fastkml>=1.1.0",
     "gpxpy>=1.6.2",
+    "lxml>=6.0.2",
     "shapely>=2.1.1",
     "srtm-py>=0.3.7",
 ]
 
-# Dev dependencies as optional dependencies
-[project.optional-dependencies]
+[dependency-groups]
 dev = [
     "pytest>=8.4.0",
     "pytest-mock>=3.14.1",
@@ -49,8 +49,8 @@ build-backend = "setuptools.build_meta"
 [tool.setuptools_scm]
 write_to = "src/python_template_project/_version.py"
 
-[tool.deptry]
-pep621_dev_dependency_groups = ["dev", "docs"]
+[tool.deptry.per_rule_ignores]
+DEP002 = ["lxml"]
 
 [tool.ruff]
 line-length = 100

python_template_project-0.2.5/pytest.ini

@@ -0,0 +1,3 @@
+[pytest]
+pythonpath = src
+testpaths = tests

{python_template_project-0.2.3 → python_template_project-0.2.5}/scripts/generate_config_docs.py

@@ -1,4 +1,4 @@
-from config_cli_gui.docs_generator import DocumentationGenerator
+from config_cli_gui.docs import DocumentationGenerator
 
 from python_template_project.config.config import ConfigParameterManager
 
@@ -18,5 +18,5 @@ print(f"Generated: {default_config}")
 docGen.generate_config_markdown_doc(output_file=default_config_doc)
 print(f"Generated: {default_config_doc}")
 
-docGen.generate_cli_markdown_doc(output_file=default_cli_doc)
+docGen.generate_cli_markdown_doc(output_file=default_cli_doc, app_name=config_manager.get_app_name())
 print(f"Generated: {default_cli_doc}")

python_template_project-0.2.5/scripts/show_filelist.py

@@ -0,0 +1,51 @@
+#!/usr/bin/env python3
+import os
+import re
+from pathlib import Path
+
+EXCLUDE_PATTERN = re.compile(
+    r"""
+    (\.pytest_cache)|
+    (\.git)|
+    (\.ruff)|
+    (\.venv)|
+    (\.github)|
+    ([/\\]build)|
+    ([/\\]dist)|
+    (\.idea)|
+    ([/\\]htmlcov)|
+    ([/\\]__pycache__)|
+    ([/\\]__main__)|
+    ([/\\]__init__)|
+    ([/\\]site)|
+    (\.pyc$)
+    """,
+    re.VERBOSE,
+)
+
+def should_exclude(path: Path) -> bool:
+    return bool(EXCLUDE_PATTERN.search(str(path)))
+
+
+def main():
+    base_path = Path.cwd()
+
+    for root, dirs, files in os.walk(base_path):
+        all_entries = dirs + files
+
+        for name in all_entries:
+            full_path = Path(root) / name
+
+            # apply exclusion filter
+            if should_exclude(full_path):
+                continue
+
+            # compute relative path
+            rel = str(full_path.relative_to(base_path))
+
+            # match PowerShell behavior: always start with "\"
+            print("\\" + rel.replace("/", "\\"))
+
+
+if __name__ == "__main__":
+    main()

{python_template_project-0.2.3 → python_template_project-0.2.5}/scripts/show_tree.py

@@ -130,7 +130,6 @@ def show_tree(path, prefix="", show_code=False):
 
         print(f"{prefix}{connector}{symbol} {item}")
         next_prefix = prefix + (INDENT if is_last else VERTICAL_LINE)
-
         if os.path.isdir(full_path):
             show_tree(full_path, next_prefix, show_code)
         elif show_code and item.endswith(".py"):
@@ -159,7 +158,7 @@ if __name__ == "__main__":
     parser.add_argument(
         "--show-code",
         action="store_true",
-        default=True,
+        default=False,
         help="Shows functions, classes and attributes in .py files",
     )
     args = parser.parse_args()
@@ -172,4 +171,4 @@ if __name__ == "__main__":
     print(f"{CLASS_SYMBOL} - Class")
     print(f"{FUNC_SYMBOL} - Function/Method")
     print(f"{ATTR_SYMBOL} - Attribute")
-
+    print(args)

python_template_project-0.2.5/src/python_template_project/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '0.2.5'
+__version_tuple__ = version_tuple = (0, 2, 5)
+
+__commit_id__ = commit_id = 'g911e64e2d'

{python_template_project-0.2.3 → python_template_project-0.2.5}/src/python_template_project/cli/cli.py

@@ -24,7 +24,7 @@ def validate_config(config: ConfigParameterManager) -> bool:
     """
     # Initialize logging system
     logger_manager = initialize_logging(config)
-    logger = logger_manager.get_logger("python_template_project.cli")
+    logger = logger_manager.get_logger("cli")
 
     # Get CLI category and check required parameters
     cli_category = config.cli
@@ -59,7 +59,7 @@ def run_main_processing(config: ConfigParameterManager) -> int:
     """
     # Initialize logging system
     logger_manager = initialize_logging(config)
-    logger = logger_manager.get_logger("python_template_project.cli")
+    logger = logger_manager.get_logger("cli")
 
     try:
         # Log startup information

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

@@ -167,14 +167,18 @@ class ConfigParameterManager(ConfigManager):  # Inherit from ConfigManager
         categories = (CliConfig(), AppConfig(), GuiConfig())
         super().__init__(categories, config_file, **kwargs)
 
+    @staticmethod
+    def get_app_name() -> str:
+        return "python_template_project"
+
 
 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"
-    app_name = "python_template_project"
     config_manager = ConfigParameterManager()
+    app_name = config_manager.get_app_name()
     doc_gen = DocumentationGenerator(config_manager)
     doc_gen.generate_default_config_file(output_file=default_config)
     print(f"Generated: {default_config}")