python-template-project 0.1.21__tar.gz → 0.2.0__tar.gz

{python_template_project-0.1.21 → python_template_project-0.2.0}/.github/workflows/build-macos.yml

@@ -30,7 +30,14 @@ jobs:
           python-version: ${{ matrix.python-version }}
 
       - name: Build Unified Executable and App Bundle with PyInstaller
-        run: make build-macos
+        run: |
+          make build-macos
+
+      - name: Prepare ZIP file for release
+        run: |
+          echo "Create the ZIP archive from the contents of the release folder"
+          cd release
+          zip -r ../package-macOS.zip .
 
       - name: Upload ZIP to GitHub Release
         uses: softprops/action-gh-release@v2

{python_template_project-0.1.21 → python_template_project-0.2.0}/HISTORY.md

@@ -4,6 +4,14 @@ Changelog
 
 (unreleased)
 ------------
+- Feat #33: Support kml files for input and display output files as
+  clickable links #33. [Paul Magister]
+- Feat #31: move project specific namings into makefile so that it can
+  be renamed. [Paul Magister]
+
+
+0.1.20 (2025-06-20)
+-------------------
 - Feat #31: move project specific namings into makefile so that it can
   be renamed. [Paul Magister]
 - Feat #31: move project specific namings into makefile so that it can

{python_template_project-0.1.21 → python_template_project-0.2.0}/Makefile

@@ -87,10 +87,6 @@ build-macos:    ## Build the macOS executable.
 	cp README.md release/
 	echo "Create usage instructions"
 
-	echo "Create the ZIP archive from the contents of the release folder"
-	cd release
-	zip -r ../package-macOS.zip .
-
 .PHONY: watch
 watch:            ## Run tests on every change.
 	ls **/**.py | entr uv run pytest -s -vvv -l --tb=long --maxfail=1 tests/
@@ -166,6 +162,10 @@ list:            ## Show project file list (excluding ignored folders)
 tree:            ## Show project tree (excluding ignored folders)
 	@powershell -NoProfile -ExecutionPolicy Bypass -File ./scripts/show_tree.ps1
 
+.PHONY: pytree
+pytree:            ## Show project tree (excluding ignored folders)
+	@uv run ./scripts/show_tree.py
+
 .PHONY: init
 init:             ## Initialize the project based on an application template.
 	@./.github/init.sh

{python_template_project-0.1.21/src/python_template_project.egg-info → python_template_project-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-template-project
-Version: 0.1.21
+Version: 0.2.0
 Summary: Feature-rich Python project template designed for robustness and ease of use.
 Author: pamagister
 Requires-Python: <3.12,>=3.10
@@ -41,30 +41,98 @@ A feature-rich Python project template with with auto-generated CLI, GUI and par
 [![License](https://img.shields.io/github/license/pamagister/python-template-project)](https://github.com/pamagister/python-template-project/blob/main/LICENSE)
 [![GitHub issues](https://img.shields.io/github/issues/pamagister/python-template-project)](https://github.com/pamagister/python-template-project/issues)
 [![PyPI](https://img.shields.io/pypi/v/python-template-project)](https://pypi.org/project/python-template-project/)
+[![Downloads](https://pepy.tech/badge/python-template-project)](https://pepy.tech/project/python-template-project/)
 
 
 This template provides a solid foundation for your next Python project, incorporating best practices for testing, automation, and distribution. It streamlines the development process with a comprehensive set of pre-configured tools and workflows, allowing you to focus on writing code.
 
-## Installation
+---
 
-Download from [PyPI](https://pypi.org/).
+## How to use this template
 
-💾 For more installation options see [install](getting-started/install.md).
+Getting started on developing your own project based on this template
 
-```bash
-pip install python-template-project
-```
+> **DO NOT FORK** 
+> This project is meant to be used from **[Use this template](https://github.com/pamagister/python-template-project/generate)** feature.
 
-Run GUI from command line
+---
 
-```bash
-python-template-project-gui
-```
+1. **Create a new repository using GitHub template**  
+   Click on **[Use this template](https://github.com/pamagister/python-template-project/generate)**.
 
-## How to use this template
+2. **Give a name to your project**  
+   For example: `my-python-project`  
+   *(Hyphens may ne used as project name; they are converted during renaming internally to underscores for packages.)*
+
+3. **Set write permissions**  
+   Go to: `Repository -> Settings -> Actions -> General -> Workflow permissions`  
+   Select: `Read and write permissions`, then click **Save**.
+
+4. **Trigger rename workflow**  
+   Navigate to `Actions` tab → Select **Rename Action** → Run workflow on the `main` branch.
+
+5. **Wait for the workflow to finish**
+
+6. **Clone the repository**  
+   Run:  
+   ```bash
+   git clone [your-github-url]
+   ```
+
+7. **Open the project in your IDE**
 
-🐍 For details, see the [Getting Started](develop/01_getting_started_dev.md) guide.
+8. **Install dependencies and create virtual environment**
+   Run:
 
+   ```bash
+   make install
+   ```
+
+9. **Configure your IDE**
+   Set `.venv` as the local Python virtual environment.
+
+10. **Adjust project metadata**
+    Modify `pyproject.toml` (e.g., project description, authors, license, etc.)
+
+11. **Clean up template scripts**
+    Delete the files:
+
+    * `rename_project.yml`
+    * `rename_project.sh`
+
+12. **Format your codebase**
+    Run:
+
+    ```bash
+    make fmt
+    ```
+
+    This will auto-format your files and reorder imports (based on any name changes).
+
+13. **Enable pre-commit hooks**
+    Run:
+
+    ```bash
+    uv run pre-commit install
+    ```
+
+14. **Add repository to ReadTheDocs**
+    Visit: [https://app.readthedocs.org/dashboard/import/](https://app.readthedocs.org/dashboard/import/)
+
+15. **Configure PyPI publishing**
+
+    * Generate a **PyPI API token** from your PyPI account.
+    * Go to **GitHub → Settings → Secrets and variables → Actions**.
+    * Add the secret as `PYPI_API_TOKEN`.
+
+16. **Release your first version**
+    Run:
+
+    ```bash
+    make release
+    ```
+    
+---
 
 ## Feature overview
 
@@ -86,3 +154,49 @@ python-template-project-gui
     * **[setuptools](https://pypi.org/project/setuptools/)** is used to package the project and manage dependencies.
     * **[setuptools-scm](https://pypi.org/project/setuptools-scm/)** is used to automatically generate the `_version.py` file from the `pyproject.toml` file.
 
+---
+
+## Installation
+
+Get an impression of how your own project could be installed and look like.
+
+Download from [PyPI](https://pypi.org/).
+
+💾 For more installation options see [install](getting-started/install.md).
+
+```bash
+pip install python-template-project
+```
+
+Run GUI from command line
+
+```bash
+python-template-project-gui
+```
+
+Run application from command line using CLI
+
+```bash
+python -m python_template_project.cli [OPTIONS] path/to/file
+```
+
+```bash
+python-template-project-cli [OPTIONS] path/to/file
+```
+
+---
+
+## Troubleshooting
+
+### Problems with release pipeline
+
+If you get this error below:
+```bash
+/home/runner/work/_temp/xxxx_xxx.sh: line 1: .github/release_message.sh: Permission denied
+```
+
+You have to run these commands in your IDE Terminal or the git bash and then push the changes.
+```bash
+git update-index --chmod=+x ./.github/release_message.sh
+```
+

{python_template_project-0.1.21 → python_template_project-0.2.0}/README.md

@@ -10,30 +10,98 @@ A feature-rich Python project template with with auto-generated CLI, GUI and par
 [![License](https://img.shields.io/github/license/pamagister/python-template-project)](https://github.com/pamagister/python-template-project/blob/main/LICENSE)
 [![GitHub issues](https://img.shields.io/github/issues/pamagister/python-template-project)](https://github.com/pamagister/python-template-project/issues)
 [![PyPI](https://img.shields.io/pypi/v/python-template-project)](https://pypi.org/project/python-template-project/)
+[![Downloads](https://pepy.tech/badge/python-template-project)](https://pepy.tech/project/python-template-project/)
 
 
 This template provides a solid foundation for your next Python project, incorporating best practices for testing, automation, and distribution. It streamlines the development process with a comprehensive set of pre-configured tools and workflows, allowing you to focus on writing code.
 
-## Installation
+---
 
-Download from [PyPI](https://pypi.org/).
+## How to use this template
 
-💾 For more installation options see [install](docs/getting-started/install.md).
+Getting started on developing your own project based on this template
 
-```bash
-pip install python-template-project
-```
+> **DO NOT FORK** 
+> This project is meant to be used from **[Use this template](https://github.com/pamagister/python-template-project/generate)** feature.
 
-Run GUI from command line
+---
 
-```bash
-python-template-project-gui
-```
+1. **Create a new repository using GitHub template**  
+   Click on **[Use this template](https://github.com/pamagister/python-template-project/generate)**.
 
-## How to use this template
+2. **Give a name to your project**  
+   For example: `my-python-project`  
+   *(Hyphens may ne used as project name; they are converted during renaming internally to underscores for packages.)*
+
+3. **Set write permissions**  
+   Go to: `Repository -> Settings -> Actions -> General -> Workflow permissions`  
+   Select: `Read and write permissions`, then click **Save**.
+
+4. **Trigger rename workflow**  
+   Navigate to `Actions` tab → Select **Rename Action** → Run workflow on the `main` branch.
+
+5. **Wait for the workflow to finish**
+
+6. **Clone the repository**  
+   Run:  
+   ```bash
+   git clone [your-github-url]
+   ```
+
+7. **Open the project in your IDE**
 
-🐍 For details, see the [Getting Started](docs/develop/01_getting_started_dev.md) guide.
+8. **Install dependencies and create virtual environment**
+   Run:
 
+   ```bash
+   make install
+   ```
+
+9. **Configure your IDE**
+   Set `.venv` as the local Python virtual environment.
+
+10. **Adjust project metadata**
+    Modify `pyproject.toml` (e.g., project description, authors, license, etc.)
+
+11. **Clean up template scripts**
+    Delete the files:
+
+    * `rename_project.yml`
+    * `rename_project.sh`
+
+12. **Format your codebase**
+    Run:
+
+    ```bash
+    make fmt
+    ```
+
+    This will auto-format your files and reorder imports (based on any name changes).
+
+13. **Enable pre-commit hooks**
+    Run:
+
+    ```bash
+    uv run pre-commit install
+    ```
+
+14. **Add repository to ReadTheDocs**
+    Visit: [https://app.readthedocs.org/dashboard/import/](https://app.readthedocs.org/dashboard/import/)
+
+15. **Configure PyPI publishing**
+
+    * Generate a **PyPI API token** from your PyPI account.
+    * Go to **GitHub → Settings → Secrets and variables → Actions**.
+    * Add the secret as `PYPI_API_TOKEN`.
+
+16. **Release your first version**
+    Run:
+
+    ```bash
+    make release
+    ```
+    
+---
 
 ## Feature overview
 
@@ -55,3 +123,49 @@ python-template-project-gui
     * **[setuptools](https://pypi.org/project/setuptools/)** is used to package the project and manage dependencies.
     * **[setuptools-scm](https://pypi.org/project/setuptools-scm/)** is used to automatically generate the `_version.py` file from the `pyproject.toml` file.
 
+---
+
+## Installation
+
+Get an impression of how your own project could be installed and look like.
+
+Download from [PyPI](https://pypi.org/).
+
+💾 For more installation options see [install](docs/getting-started/install.md).
+
+```bash
+pip install python-template-project
+```
+
+Run GUI from command line
+
+```bash
+python-template-project-gui
+```
+
+Run application from command line using CLI
+
+```bash
+python -m python_template_project.cli [OPTIONS] path/to/file
+```
+
+```bash
+python-template-project-cli [OPTIONS] path/to/file
+```
+
+---
+
+## Troubleshooting
+
+### Problems with release pipeline
+
+If you get this error below:
+```bash
+/home/runner/work/_temp/xxxx_xxx.sh: line 1: .github/release_message.sh: Permission denied
+```
+
+You have to run these commands in your IDE Terminal or the git bash and then push the changes.
+```bash
+git update-index --chmod=+x ./.github/release_message.sh
+```
+

python_template_project-0.2.0/config.yaml

@@ -0,0 +1,96 @@
+# Configuration File
+# This file was auto-generated. Modify as needed.
+
+# CLI Configuration
+cli:
+  # Path to input (file or folder)
+  # Type: str
+  input: ''
+
+  # Path to output destination
+  # Type: str
+  output: ''
+
+  # Maximum distance between two waypoints
+  # Type: int
+  min_dist: 20
+
+  # Extract starting points of each track as waypoint
+  # Choices: [True, False]
+  # Type: bool
+  extract_waypoints: True
+
+  # Include elevation data in waypoints
+  # Choices: [True, False]
+  # Type: bool
+  elevation: True
+
+
+# APP Configuration
+app:
+  # Date format to use
+  # Type: str
+  date_format: '%Y-%m-%d'
+
+  # Logging level for the application
+  # Choices: ['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL']
+  # Type: str
+  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
+  # Choices: ['simple', 'detailed', 'json']
+  # Type: str
+  log_format: 'detailed'
+
+  # Maximum number of worker threads
+  # Type: int
+  max_workers: 4
+
+  # Enable logging to file
+  # Choices: [True, False]
+  # Type: bool
+  enable_file_logging: True
+
+  # Enable logging to console
+  # Choices: [True, False]
+  # Type: bool
+  enable_console_logging: True
+
+
+# GUI Configuration
+gui:
+  # GUI theme setting
+  # Choices: ['light', 'dark', 'auto']
+  # Type: str
+  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 newest log entries
+  # Choices: [True, False]
+  # Type: bool
+  auto_scroll_log: True
+
+  # Maximum number of log lines to keep in GUI
+  # Type: int
+  max_log_lines: 1000
+
+

{python_template_project-0.1.21 → python_template_project-0.2.0}/docs/index.md

@@ -8,30 +8,98 @@ A feature-rich Python project template with with auto-generated CLI, GUI and par
 [![License](https://img.shields.io/github/license/pamagister/python-template-project)](https://github.com/pamagister/python-template-project/blob/main/LICENSE)
 [![GitHub issues](https://img.shields.io/github/issues/pamagister/python-template-project)](https://github.com/pamagister/python-template-project/issues)
 [![PyPI](https://img.shields.io/pypi/v/python-template-project)](https://pypi.org/project/python-template-project/)
+[![Downloads](https://pepy.tech/badge/python-template-project)](https://pepy.tech/project/python-template-project/)
 
 
 This template provides a solid foundation for your next Python project, incorporating best practices for testing, automation, and distribution. It streamlines the development process with a comprehensive set of pre-configured tools and workflows, allowing you to focus on writing code.
 
-## Installation
+---
 
-Download from [PyPI](https://pypi.org/).
+## How to use this template
 
-💾 For more installation options see [install](getting-started/install.md).
+Getting started on developing your own project based on this template
 
-```bash
-pip install python-template-project
-```
+> **DO NOT FORK** 
+> This project is meant to be used from **[Use this template](https://github.com/pamagister/python-template-project/generate)** feature.
 
-Run GUI from command line
+---
 
-```bash
-python-template-project-gui
-```
+1. **Create a new repository using GitHub template**  
+   Click on **[Use this template](https://github.com/pamagister/python-template-project/generate)**.
 
-## How to use this template
+2. **Give a name to your project**  
+   For example: `my-python-project`  
+   *(Hyphens may ne used as project name; they are converted during renaming internally to underscores for packages.)*
+
+3. **Set write permissions**  
+   Go to: `Repository -> Settings -> Actions -> General -> Workflow permissions`  
+   Select: `Read and write permissions`, then click **Save**.
+
+4. **Trigger rename workflow**  
+   Navigate to `Actions` tab → Select **Rename Action** → Run workflow on the `main` branch.
+
+5. **Wait for the workflow to finish**
+
+6. **Clone the repository**  
+   Run:  
+   ```bash
+   git clone [your-github-url]
+   ```
+
+7. **Open the project in your IDE**
 
-🐍 For details, see the [Getting Started](develop/01_getting_started_dev.md) guide.
+8. **Install dependencies and create virtual environment**
+   Run:
 
+   ```bash
+   make install
+   ```
+
+9. **Configure your IDE**
+   Set `.venv` as the local Python virtual environment.
+
+10. **Adjust project metadata**
+    Modify `pyproject.toml` (e.g., project description, authors, license, etc.)
+
+11. **Clean up template scripts**
+    Delete the files:
+
+    * `rename_project.yml`
+    * `rename_project.sh`
+
+12. **Format your codebase**
+    Run:
+
+    ```bash
+    make fmt
+    ```
+
+    This will auto-format your files and reorder imports (based on any name changes).
+
+13. **Enable pre-commit hooks**
+    Run:
+
+    ```bash
+    uv run pre-commit install
+    ```
+
+14. **Add repository to ReadTheDocs**
+    Visit: [https://app.readthedocs.org/dashboard/import/](https://app.readthedocs.org/dashboard/import/)
+
+15. **Configure PyPI publishing**
+
+    * Generate a **PyPI API token** from your PyPI account.
+    * Go to **GitHub → Settings → Secrets and variables → Actions**.
+    * Add the secret as `PYPI_API_TOKEN`.
+
+16. **Release your first version**
+    Run:
+
+    ```bash
+    make release
+    ```
+    
+---
 
 ## Feature overview
 
@@ -53,3 +121,49 @@ python-template-project-gui
     * **[setuptools](https://pypi.org/project/setuptools/)** is used to package the project and manage dependencies.
     * **[setuptools-scm](https://pypi.org/project/setuptools-scm/)** is used to automatically generate the `_version.py` file from the `pyproject.toml` file.
 
+---
+
+## Installation
+
+Get an impression of how your own project could be installed and look like.
+
+Download from [PyPI](https://pypi.org/).
+
+💾 For more installation options see [install](getting-started/install.md).
+
+```bash
+pip install python-template-project
+```
+
+Run GUI from command line
+
+```bash
+python-template-project-gui
+```
+
+Run application from command line using CLI
+
+```bash
+python -m python_template_project.cli [OPTIONS] path/to/file
+```
+
+```bash
+python-template-project-cli [OPTIONS] path/to/file
+```
+
+---
+
+## Troubleshooting
+
+### Problems with release pipeline
+
+If you get this error below:
+```bash
+/home/runner/work/_temp/xxxx_xxx.sh: line 1: .github/release_message.sh: Permission denied
+```
+
+You have to run these commands in your IDE Terminal or the git bash and then push the changes.
+```bash
+git update-index --chmod=+x ./.github/release_message.sh
+```
+