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

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

@@ -4,6 +4,14 @@ Changelog
 
 (unreleased)
 ------------
+- Feat #30: release project on pypi: deploy section in release.yml.
+  [Paul Magister]
+- Feat #30: release project on pypi: rename contributing section, add
+  pypi_release.md doc. [Paul Magister]
+
+
+0.1.13 (2025-06-19)
+-------------------
 - Feat #16: fix installer link and name. [Paul Magister]
 - Feat #16: release. [Paul Magister]
 

{python_template_project-0.1.0 → python_template_project-0.1.15}/Makefile

@@ -89,19 +89,29 @@ virtualenv:       ## Create a virtual environment.
 release:          ## Create a new tag for release.
 	@echo "WARNING: This operation will create a version tag and push to GitHub"
 
-	@CURRENT_VERSION=$$(cat src/VERSION)
-	IFS=. read -r MAJOR MINOR PATCH <<< "$$CURRENT_VERSION"
-	@NEXT_VERSION="$$MAJOR.$$MINOR.$$((PATCH + 1))"
-	echo "Current version: $$CURRENT_VERSION"
-	read -e -i "$$NEXT_VERSION" -p "Version? (provide the next x.y.z semver) : " TAG
-	echo "$${TAG}" > src/VERSION
+	# Get the latest Git tag if it exists, otherwise default to 0.0.0 for calculations
+	# 'git describe --tags --abbrev=0' gets the most recent tag
+	# '|| echo 0.0.0' provides a fallback if no tags exist yet
+	@CURRENT_TAG=$$(git describe --tags --abbrev=0 2>/dev/null || echo "0.0.0")
+	@echo "Current (latest) Git tag: $$CURRENT_TAG"
+
+	# Suggest next patch version based on the current tag
+	IFS=. read -r MAJOR MINOR PATCH <<< "$$CURRENT_TAG"
+	@NEXT_PATCH_VERSION="$$MAJOR.$$MINOR.$$((PATCH + 1))"
+
+	# Prompt the user for the new tag, suggesting the next patch version by default
+	read -e -i "$$NEXT_PATCH_VERSION" -p "Enter the new release tag (e.g., 1.0.0, 1.1.0, 1.1.1): " NEW_TAG
+
+	# Generate changelog *before* tagging, based on existing history up to the new tag point
 	uv run gitchangelog > HISTORY.md
-	git add src/VERSION HISTORY.md
-	git commit -m "release: version $${TAG} 🚀"
-	echo "creating git tag : $${TAG}"
-	git tag $${TAG}
+	git add HISTORY.md
+	git commit -m "docs: Update HISTORY.md for release $${NEW_TAG}"
+
+	echo "Creating git tag : $${NEW_TAG}"
+	git tag "$${NEW_TAG}"
 	git push -u origin HEAD --tags
-	echo "GitHub Actions will detect the new tag and release the new version."
+
+	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

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

@@ -1,32 +1,33 @@
 Metadata-Version: 2.4
 Name: python-template-project
-Version: 0.1.0
+Version: 0.1.15
 Summary: Feature-rich Python project template designed for robustness and ease of use.
 Author: pamagister
-License-File: LICENSE
 Requires-Python: <3.12,>=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
 Requires-Dist: gpxpy>=1.6.2
 Requires-Dist: pydantic>=2.11.7
 Requires-Dist: pyyaml>=6.0.2
 Requires-Dist: srtm-py>=0.3.7
 Provides-Extra: dev
-Requires-Dist: black>=25.1.0; extra == 'dev'
-Requires-Dist: coverage>=7.8.2; extra == 'dev'
-Requires-Dist: flake8>=7.2.0; extra == 'dev'
-Requires-Dist: gitchangelog>=3.0.4; extra == 'dev'
-Requires-Dist: isort>=6.0.1; extra == 'dev'
-Requires-Dist: mypy>=1.16.0; extra == 'dev'
-Requires-Dist: pre-commit>=4.2.0; extra == 'dev'
-Requires-Dist: pyinstaller>=5.8; extra == 'dev'
-Requires-Dist: pytest-cov>=6.1.1; extra == 'dev'
-Requires-Dist: pytest-mock>=3.14.1; extra == 'dev'
-Requires-Dist: pytest>=8.4.0; extra == 'dev'
-Requires-Dist: ruff>=0.11.13; 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-awesome-nav>=2.6.1; extra == 'docs'
-Requires-Dist: mkdocs>=1.6.1; extra == 'docs'
-Requires-Dist: pygments>=2.19.1; extra == 'docs'
-Description-Content-Type: text/markdown
+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
 
@@ -46,17 +47,20 @@ This template provides a solid foundation for your next Python project, incorpor
 ## Feature overview
 
 * **Testing:** Unit testing setup with `pytest`.
-* **CI/CD:** GitHub Actions for automated builds (Windows, macOS), unit tests, and code checks.
-* **Code Formatting:** Pre-commit hook with the *black* auto-formatter to ensure consistent code style.
+* **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*, an extremely fast Python package manager, with dependencies managed in `pyproject.toml`.
+* **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.
+* **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.
 
 ## Getting started
 

{python_template_project-0.1.0 → python_template_project-0.1.15}/docs/index.md

@@ -16,17 +16,20 @@ This template provides a solid foundation for your next Python project, incorpor
 ## Feature overview
 
 * **Testing:** Unit testing setup with `pytest`.
-* **CI/CD:** GitHub Actions for automated builds (Windows, macOS), unit tests, and code checks.
-* **Code Formatting:** Pre-commit hook with the *black* auto-formatter to ensure consistent code style.
+* **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*, an extremely fast Python package manager, with dependencies managed in `pyproject.toml`.
+* **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.
+* **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.
 
 ## Getting started
 

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

@@ -1,6 +1,6 @@
 [project]
 name = "python-template-project"
-version = "0.1.0"
+dynamic = ["version"]
 description = "Feature-rich Python project template designed for robustness and ease of use."
 authors = [
     {name = "pamagister"}
@@ -42,12 +42,11 @@ python-template-project = "python_template_project.cli.cli:main"
 python-template-project-gui = "python_template_project.gui.gui:main"
 
 [build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
+requires = ["setuptools>=61.0", "wheel", "setuptools_scm[toml]>=6.2"]
+build-backend = "setuptools.build_meta"
 
-# Hatchling-spezifische Konfiguration für src-Layout
-[tool.hatch.build.targets.wheel]
-packages = ["src/python_template_project"]
+[tool.setuptools_scm]
+write_to = "src/python_template_project/_version.py"
 
 [tool.deptry]
 pep621_dev_dependency_groups = ["dev", "docs"]

python_template_project-0.1.15/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

python_template_project-0.1.15/src/VERSION

@@ -0,0 +1 @@
+0.1.14

python_template_project-0.1.15/src/python_template_project/_version.py

@@ -0,0 +1,21 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+else:
+    VERSION_TUPLE = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+
+__version__ = version = '0.1.15'
+__version_tuple__ = version_tuple = (0, 1, 15)

python_template_project-0.1.15/src/python_template_project.egg-info/PKG-INFO

@@ -0,0 +1,96 @@
+Metadata-Version: 2.4
+Name: python-template-project
+Version: 0.1.15
+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: gpxpy>=1.6.2
+Requires-Dist: pydantic>=2.11.7
+Requires-Dist: pyyaml>=6.0.2
+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.
+
+[![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.
+
+
+## Feature overview
+
+* **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.
+
+## 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
+```
+
+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/src/python_template_project.egg-info/SOURCES.txt

@@ -0,0 +1,72 @@
+.gitignore
+.pre-commit-config.yaml
+.readthedocs.yaml
+HISTORY.md
+LICENSE
+Makefile
+README.md
+config.yaml
+mkdocs.yml
+pyproject.toml
+uv.lock
+.github/FUNDING.yml
+.github/PULL_REQUEST_TEMPLATE.md
+.github/dependabot.yml
+.github/init.sh
+.github/release_message.sh
+.github/rename_project.sh
+.github/ISSUE_TEMPLATE/bug_report.md
+.github/ISSUE_TEMPLATE/feature_request.md
+.github/actions/setup-environment/action.yml
+.github/workflows/build-macos.yml
+.github/workflows/build.yml
+.github/workflows/main.yml
+.github/workflows/release.yml
+.github/workflows/update-readme.yml
+.idea/runConfigurations/config_generate.xml
+.idea/runConfigurations/module_cli.xml
+.idea/runConfigurations/module_gui.xml
+docs/.nav.yml
+docs/index.md
+docs/_static/img/favicon.png
+docs/_static/img/logo.png
+docs/css/custom.css
+docs/develop/contributing.md
+docs/develop/make_windows.md
+docs/develop/pypi_release.md
+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/update_readme.py
+src/VERSION
+src/__init__.py
+src/main.py
+src/python_template_project/__init__.py
+src/python_template_project/__main__.py
+src/python_template_project/_version.py
+src/python_template_project.egg-info/PKG-INFO
+src/python_template_project.egg-info/SOURCES.txt
+src/python_template_project.egg-info/dependency_links.txt
+src/python_template_project.egg-info/entry_points.txt
+src/python_template_project.egg-info/requires.txt
+src/python_template_project.egg-info/top_level.txt
+src/python_template_project/cli/__init__.py
+src/python_template_project/cli/__main__.py
+src/python_template_project/cli/cli.py
+src/python_template_project/config/__init__.py
+src/python_template_project/config/config.py
+src/python_template_project/core/__init__.py
+src/python_template_project/core/base.py
+src/python_template_project/core/logging.py
+src/python_template_project/gui/__init__.py
+src/python_template_project/gui/__main__.py
+src/python_template_project/gui/gui.py
+tests/__init__.py
+tests/test_generic_cli.py
+tests/test_gpx.py

python_template_project-0.1.15/src/python_template_project.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

python_template_project-0.1.15/src/python_template_project.egg-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+python-template-project = python_template_project.cli.cli:main
+python-template-project-gui = python_template_project.gui.gui:main

python_template_project-0.1.15/src/python_template_project.egg-info/requires.txt

@@ -0,0 +1,23 @@
+gpxpy>=1.6.2
+pydantic>=2.11.7
+pyyaml>=6.0.2
+srtm-py>=0.3.7
+
+[dev]
+pytest>=8.4.0
+pytest-mock>=3.14.1
+coverage>=7.8.2
+flake8>=7.2.0
+black>=25.1.0
+isort>=6.0.1
+pytest-cov>=6.1.1
+mypy>=1.16.0
+gitchangelog>=3.0.4
+pyinstaller>=5.8
+pre-commit>=4.2.0
+ruff>=0.11.13
+
+[docs]
+mkdocs>=1.6.1
+mkdocs-awesome-nav>=2.6.1
+pygments>=2.19.1

python_template_project-0.1.15/src/python_template_project.egg-info/top_level.txt

@@ -0,0 +1,3 @@
+__init__
+main
+python_template_project

{python_template_project-0.1.0 → python_template_project-0.1.15}/uv.lock

@@ -719,7 +719,6 @@ wheels = [
 
 [[package]]
 name = "python-template-project"
-version = "0.1.0"
 source = { editable = "." }
 dependencies = [
     { name = "gpxpy" },

python_template_project-0.1.0/src/VERSION

@@ -1 +0,0 @@
-0.1.13