python-template-project 0.1.15__tar.gz → 0.1.18__tar.gz

{python_template_project-0.1.15 → python_template_project-0.1.18}/.github/rename_project.sh

@@ -18,19 +18,20 @@ echo "Renaming project..."
 
 original_author="pamagister"
 original_name="python-template-project"
+original_package_name="python_template_project"
 original_urlname="python-template-project"
 original_description="Awesome python-template-project created by pamagister"
 # for filename in $(find . -name "*.*") 
 for filename in $(git ls-files) 
 do
     sed -i "s/$original_author/$author/g" $filename
-    sed -i "s/$original_name/$name/g" $filename
+    sed -i "s/$original_package_name/$name/g" $filename
     sed -i "s/$original_urlname/$urlname/g" $filename
     sed -i "s/$original_description/$description/g" $filename
     echo "Renamed $filename"
 done
 
-mv python-template-project $name
+mv original_name $name
 
 # This command runs only once on GHA!
 rm -rf .github/template.yml

{python_template_project-0.1.15 → python_template_project-0.1.18}/.github/workflows/build.yml

@@ -29,9 +29,7 @@ jobs:
           python-version: ${{ matrix.python-version }}
 
       - name: Build Unified EXE with PyInstaller
-        run: |
-          echo "Building unified CLI/GUI application"
-          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
+        run: make build-win
 
       - name: Prepare ZIP file for release
         run: |

python_template_project-0.1.18/.github/workflows/rename_project.yml

@@ -0,0 +1,42 @@
+name: Rename the project from template
+
+on: [push]
+
+permissions: write-all
+
+jobs:
+  rename-project:
+    if: ${{ !contains (github.repository, '/python-template-project') }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          # by default, it uses a depth of 1
+          # this fetches all history so that we can read each commit
+          fetch-depth: 0
+          ref: ${{ github.head_ref }}
+          
+      - run: echo "REPOSITORY_NAME=$(echo '${{ github.repository }}' | awk -F '/' '{print $2}' | tr '-' '_' | tr '[:upper:]' '[:lower:]')" >> $GITHUB_ENV
+        shell: bash
+
+      - run: echo "REPOSITORY_URLNAME=$(echo '${{ github.repository }}' | awk -F '/' '{print $2}')" >> $GITHUB_ENV
+        shell: bash
+
+      - run: echo "REPOSITORY_OWNER=$(echo '${{ github.repository }}' | awk -F '/' '{print $1}')" >> $GITHUB_ENV
+        shell: bash
+        
+      - name: Is this still a template
+        id: is_template
+        run: echo "::set-output name=is_template::$(ls .github/template.yml &> /dev/null && echo true || echo false)"
+
+      - name: Rename the project
+        if: steps.is_template.outputs.is_template == 'true'
+        run: |
+          echo "Renaming the project with -a(author) ${{ env.REPOSITORY_OWNER }} -n(name) ${{ env.REPOSITORY_NAME }} -u(urlname) ${{ env.REPOSITORY_URLNAME }}"
+          .github/rename_project.sh -a ${{ env.REPOSITORY_OWNER }} -n ${{ env.REPOSITORY_NAME }} -u ${{ env.REPOSITORY_URLNAME }} -d "Awesome ${{ env.REPOSITORY_NAME }} created by ${{ env.REPOSITORY_OWNER }}"
+              
+      - uses: pamagister/git-auto-commit-action@v4
+        with:
+          commit_message: "✅ Ready to clone and code."
+          # commit_options: '--amend --no-edit'
+          push_options: --force

{python_template_project-0.1.15 → python_template_project-0.1.18}/HISTORY.md

@@ -4,6 +4,35 @@ Changelog
 
 (unreleased)
 ------------
+- Feat #30: fix link issue by modifying link in README.md. [Paul
+  Magister]
+
+
+0.1.16 (2025-06-20)
+-------------------
+- Fix #29: more rubust usage of srtm in case of connection issues. [Paul
+  Magister]
+- Feat #30: exclude _version.py from check. [Paul Magister]
+- Feat #31: doc on how to generate. [Paul Magister]
+- Feat #30: exclude _version.py from check. [Paul Magister]
+- Feat #31: enable project to be copied #31. [Paul Magister]
+- Feat #27: move build logic into make file #27. [Paul Magister]
+- Feat #30: improve README.md, fix utf8-issues on copying. [Paul
+  Magister]
+- Feat #30: correct doc how to install and use this project. [Paul
+  Magister]
+- Feat #30: add _version.py instead of VERSION. [Paul Magister]
+- Update README.md from docs/index.md. [github-actions]
+
+
+0.1.15 (2025-06-20)
+-------------------
+- Feat #30: switch build system to setuptools_scm. [Paul Magister]
+- Feat #30: add some links to the doc. [Paul Magister]
+
+
+0.1.14 (2025-06-20)
+-------------------
 - Feat #30: release project on pypi: deploy section in release.yml.
   [Paul Magister]
 - Feat #30: release project on pypi: rename contributing section, add

{python_template_project-0.1.15 → python_template_project-0.1.18}/Makefile

@@ -55,6 +55,11 @@ 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 python-template-project --add-data "config.yaml;." --hidden-import python_template_project.cli.cli --hidden-import python_template_project.gui.gui
+
 .PHONY: watch
 watch:            ## Run tests on every change.
 	ls **/**.py | entr uv run pytest -s -vvv -l --tb=long --maxfail=1 tests/

{python_template_project-0.1.15 → python_template_project-0.1.18}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-template-project
-Version: 0.1.15
+Version: 0.1.18
 Summary: Feature-rich Python project template designed for robustness and ease of use.
 Author: pamagister
 Requires-Python: <3.12,>=3.10
@@ -43,54 +43,44 @@ A feature-rich Python project template with with auto-generated CLI, GUI and par
 
 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
 
-## Feature overview
+Download from [PyPI](https://pypi.org/).
 
-* **Testing:** Unit testing setup with `pytest`.
-* **CI/CD:**  [GitHub Actions](https://github.com/features/actions) for automated builds (Windows, macOS), unit tests, and code checks.
-* **Code Formatting and Linting:** Pre-commit hook with the [RUFF auto-formatter](https://docs.astral.sh/ruff/) to ensure consistent code style.
-* **Automated Builds:** GitHub pipeline for automatically building a Windows executable and a macOS installer.
-* **Package Management:** Utilizes [uv](https://docs.astral.sh/uv/getting-started/), an extremely fast Python package manager, with dependencies managed in `pyproject.toml`.
-* **Parameter-Driven Automation:**
-    * Automatic generation of a configuration file from parameter definitions.
-    * Automatic generation of a Command-Line Interface (CLI) from the same parameters.
-    * Automatic generation of CLI API documentation.
-* **Documentation:** Configuration for publishing documentation on [Read the Docs](https://about.readthedocs.com/) using [mkdocs](https://www.mkdocs.org/) .
-* **Workflow Automation:** A `Makefile` is included to simplify and automate common development tasks.
-* **Minimalist GUI:** Comes with a basic GUI based on [tkinker](https://tkdocs.com/tutorial/index.html) that includes an auto-generated settings menu based on your defined parameters.
-* **Release pipeline:** Automated releases unsing the Makefile `make release` command, which creates a new tag and pushes it to the remote repo. The `release` pipeline will automatically create a new release on GitHub and trigger a release on PyPI.
-    * **[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.
+💾 For more installation options see [install](getting-started/install.md).
 
-## Getting started
-
-1. **Create** a new [github repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-new-repository).
-2. **Clone** [github repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) the into your local file system.
-    ```bash
-    git clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY
-    ```
-4. **Install** [uv package and project manager](https://docs.astral.sh/uv/getting-started/installation/)
-    ```bash
-    pip install uv
-    ```
-5. **Generate** [a sample project](https://docs.astral.sh/uv/guides/projects/#creating-a-new-project) with uv
-6. Add and **push** the artifacts to your github repository
-    ```bash
-    git push
-    ```
-8. Copy the content of this repository into your repository
-
-## 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
+pip install python-template-project
 ```
 
-You have to run these commands in your IDE Terminal or the git bash and then push the changes.
+Run GUI from command line
+
 ```bash
-git update-index --chmod=+x ./.github/release_message.sh
+python-template-project-gui
 ```
 
+## How to use this template
+
+🐍 For details, see the [Getting Started](develop/01_getting_started_dev.md) guide.
+
+
+## Feature overview
+
+* 📦 **Package Management:** Utilizes [uv](https://docs.astral.sh/uv/getting-started/), an extremely fast Python package manager, with dependencies managed in `pyproject.toml`.
+* ✅ **Code Formatting and Linting:** Pre-commit hook with the [RUFF auto-formatter](https://docs.astral.sh/ruff/) to ensure consistent code style.
+* 🧪 **Testing:** Unit testing framework with [pytest](https://docs.pytest.org/en/latest/).
+* 📊 **Code coverage reports** using [codecov](https://about.codecov.io/sign-up/)
+* 🔄 **CI/CD:**  [GitHub Actions](https://github.com/features/actions) for automated builds (Windows, macOS), unit tests, and code checks.
+* 💾 **Automated Builds:** GitHub pipeline for automatically building a Windows executable and a macOS installer.
+* 💬 **Parameter-Driven Automation:**
+    * Automatic generation of a configuration file from parameter definitions.
+    * Automatic generation of a Command-Line Interface (CLI) from the same parameters.
+    * Automatic generation of CLI API documentation.
+    * Automatic generation of change log using **gitchangelog** to keep a HISTORY.md file up to date.
+* 📃 **Documentation:** Configuration for publishing documentation on [Read the Docs](https://about.readthedocs.com/) using [mkdocs](https://www.mkdocs.org/) .
+* 🖼️ **Minimalist GUI:** Comes with a basic GUI based on [tkinker](https://tkdocs.com/tutorial/index.html) that includes an auto-generated settings menu based on your defined parameters.
+* 🖥️ **Workflow Automation:** A `Makefile` is included to simplify and automate common development tasks.
+* 🛳️ **Release pipeline:** Automated releases unsing the Makefile `make release` command, which creates a new tag and pushes it to the remote repo. The `release` pipeline will automatically create a new release on GitHub and trigger a release on  [PyPI](https://pypi.org.
+    * **[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.
+

python_template_project-0.1.18/README.md

@@ -0,0 +1,57 @@
+<!-- This README.md is auto-generated from docs/index.md -->
+
+# Welcome to python-template-project
+
+A feature-rich Python project template with 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)
+[![Read the Docs](https://readthedocs.org/projects/python-template-project/badge/?version=stable)](https://python-template-project.readthedocs.io/en/stable/)
+[![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/)
+
+
+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/).
+
+💾 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
+```
+
+## How to use this template
+
+🐍 For details, see the [Getting Started](develop/01_getting_started_dev.md) guide.
+
+
+## Feature overview
+
+* 📦 **Package Management:** Utilizes [uv](https://docs.astral.sh/uv/getting-started/), an extremely fast Python package manager, with dependencies managed in `pyproject.toml`.
+* ✅ **Code Formatting and Linting:** Pre-commit hook with the [RUFF auto-formatter](https://docs.astral.sh/ruff/) to ensure consistent code style.
+* 🧪 **Testing:** Unit testing framework with [pytest](https://docs.pytest.org/en/latest/).
+* 📊 **Code coverage reports** using [codecov](https://about.codecov.io/sign-up/)
+* 🔄 **CI/CD:**  [GitHub Actions](https://github.com/features/actions) for automated builds (Windows, macOS), unit tests, and code checks.
+* 💾 **Automated Builds:** GitHub pipeline for automatically building a Windows executable and a macOS installer.
+* 💬 **Parameter-Driven Automation:**
+    * Automatic generation of a configuration file from parameter definitions.
+    * Automatic generation of a Command-Line Interface (CLI) from the same parameters.
+    * Automatic generation of CLI API documentation.
+    * Automatic generation of change log using **gitchangelog** to keep a HISTORY.md file up to date.
+* 📃 **Documentation:** Configuration for publishing documentation on [Read the Docs](https://about.readthedocs.com/) using [mkdocs](https://www.mkdocs.org/) .
+* 🖼️ **Minimalist GUI:** Comes with a basic GUI based on [tkinker](https://tkdocs.com/tutorial/index.html) that includes an auto-generated settings menu based on your defined parameters.
+* 🖥️ **Workflow Automation:** A `Makefile` is included to simplify and automate common development tasks.
+* 🛳️ **Release pipeline:** Automated releases unsing the Makefile `make release` command, which creates a new tag and pushes it to the remote repo. The `release` pipeline will automatically create a new release on GitHub and trigger a release on  [PyPI](https://pypi.org.
+    * **[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.
+

python_template_project-0.1.18/docs/develop/01_getting_started_dev.md

@@ -0,0 +1,29 @@
+
+# Getting started developing
+
+## Setup your project development environment
+
+Getting started on developing your own project based on this template
+
+> **DO NOT FORK** this is meant to be used from **[Use this template](https://github.com/pamagister/python-template-project/generate)** feature.
+
+1. Click on **[Use this template](https://github.com/pamagister/python-template-project/generate)**
+3. Give a name to your project  
+   (e.g. `my_python_project` recommendation is to use all lowercase and underscores separation for repo names.)
+3. Wait until the first run of CI finishes  
+   (Github Actions will process the template and commit to your new repo)
+
+## 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.15 → python_template_project-0.1.18}/docs/getting-started/install.md

@@ -1,45 +1,66 @@
 # Installation
 
 
+## 🐍 PyPI
 
-## 🐍 Install from PyPI 
+### Install the package from PyPI
+
+Download from [PyPI](https://pypi.org/):
 
 ```bash
-python -m pip install python_template_project
+pip install python-template-project
 ```
 
+### Run CLI from command line
+```bash
+python-template-project [OPTIONS] path/to/file
+```
 
-## 🔽 Download installer
+### Run GUI from command line
+```bash
+python-template-project-gui
+```
+
+## 🔽 Executable
+
+Download the latest executable:
 
 - [⬇️ Download for Windows](https://github.com/pamagister/python-template-project/releases/latest/download/installer-win.zip)
 - [⬇️ Download for macOS](https://github.com/pamagister/python-template-project/releases/latest/download/package-macos.zip)
 
 
+## 👩🏼‍💻 Run from source
 
-## Run from source
-
-### Run with CLI from source
+### Clone the repository
 
 ```bash
-python -m python_template_project.cli [OPTIONS] path/to/file
+git clone
 ```
 
+### Navigate to the project directory
 
-### Run with GUI from source
+```bash
+cd python-template-project
+```
+
+### Install dependencies
 
 ```bash
-python -m python_template_project.gui
+uv venv
+uv pip install -e .[dev,docs]
 ```
 
 
-## Run from command line:
+### Run with CLI from source
 
-### Run CLI from command line
 ```bash
-python-template-project [OPTIONS] path/to/file
+python -m python_template_project.cli [OPTIONS] path/to/file
 ```
 
-### Run GUI from command line
+
+### Run with GUI from source
+
 ```bash
-python-template-project-gui
+python -m python_template_project.gui
 ```
+

python_template_project-0.1.18/docs/index.md

@@ -0,0 +1,55 @@
+# Welcome to python-template-project
+
+A feature-rich Python project template with 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)
+[![Read the Docs](https://readthedocs.org/projects/python-template-project/badge/?version=stable)](https://python-template-project.readthedocs.io/en/stable/)
+[![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/)
+
+
+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/).
+
+💾 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
+```
+
+## How to use this template
+
+🐍 For details, see the [Getting Started](develop/01_getting_started_dev.md) guide.
+
+
+## Feature overview
+
+* 📦 **Package Management:** Utilizes [uv](https://docs.astral.sh/uv/getting-started/), an extremely fast Python package manager, with dependencies managed in `pyproject.toml`.
+* ✅ **Code Formatting and Linting:** Pre-commit hook with the [RUFF auto-formatter](https://docs.astral.sh/ruff/) to ensure consistent code style.
+* 🧪 **Testing:** Unit testing framework with [pytest](https://docs.pytest.org/en/latest/).
+* 📊 **Code coverage reports** using [codecov](https://about.codecov.io/sign-up/)
+* 🔄 **CI/CD:**  [GitHub Actions](https://github.com/features/actions) for automated builds (Windows, macOS), unit tests, and code checks.
+* 💾 **Automated Builds:** GitHub pipeline for automatically building a Windows executable and a macOS installer.
+* 💬 **Parameter-Driven Automation:**
+    * Automatic generation of a configuration file from parameter definitions.
+    * Automatic generation of a Command-Line Interface (CLI) from the same parameters.
+    * Automatic generation of CLI API documentation.
+    * Automatic generation of change log using **gitchangelog** to keep a HISTORY.md file up to date.
+* 📃 **Documentation:** Configuration for publishing documentation on [Read the Docs](https://about.readthedocs.com/) using [mkdocs](https://www.mkdocs.org/) .
+* 🖼️ **Minimalist GUI:** Comes with a basic GUI based on [tkinker](https://tkdocs.com/tutorial/index.html) that includes an auto-generated settings menu based on your defined parameters.
+* 🖥️ **Workflow Automation:** A `Makefile` is included to simplify and automate common development tasks.
+* 🛳️ **Release pipeline:** Automated releases unsing the Makefile `make release` command, which creates a new tag and pushes it to the remote repo. The `release` pipeline will automatically create a new release on GitHub and trigger a release on  [PyPI](https://pypi.org.
+    * **[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.
+

{python_template_project-0.1.15 → python_template_project-0.1.18}/pyproject.toml

@@ -54,6 +54,7 @@ pep621_dev_dependency_groups = ["dev", "docs"]
 [tool.ruff]
 line-length = 100
 target-version = "py310"
+exclude = ["src/python_template_project/_version.py"]
 
 [tool.ruff.lint]
 select = [

python_template_project-0.1.18/scripts/update_readme.py

@@ -0,0 +1,21 @@
+# scripts/update_readme.py
+from pathlib import Path
+
+src = Path("docs/index.md")
+dst = Path("README.md")
+
+# Optional: prepend a note that it's generated
+prefix = "<!-- This README.md is auto-generated from docs/index.md -->\n\n"
+
+# Lese die Quelldatei explizit mit UTF-8 Kodierung
+source_content = src.read_text(encoding="utf-8")
+
+# Schreibe den Inhalt in die Zieldatei, ebenfalls mit UTF-8 Kodierung
+dst.write_text(
+    prefix
+    + source_content.replace("](getting-started\/", "](docs/getting-started/").replace(
+        "](develop\/", "](docs/develop/"
+    ),
+    encoding="utf-8",
+)
+print(f"DONE    -  {dst} updated from {src}")