[NEW] Python Project Generator v2.5.10

Release v2.5.10

Author: boromir674

CHANGELOG.rst

@@ -3,6 +3,22 @@ Changelog
 =========
 
 
+2.5.10 (2025-05-10)
+===================
+
+Changes
+^^^^^^^
+
+documentation
+"""""""""""""
+- add badges in Docs Site Landing Page
+- fix link
+
+chore
+"""""
+- sem ver bump to 2.5.10
+
+
 2.5.9 (2025-05-10)
 ==================
 

README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://img.shields.io/github/actions/workflow/status/boromir674/cookiecutter-python-package/test.yaml?link=https%3A%2F%2Fgithub.com%2Fboromir674%2Fcookiecutter-python-package%2Factions%2Fworkflows%2Ftest.yaml%3Fquery%3Dbranch%253Amaster)](https://github.com/boromir674/cookiecutter-python-package/actions/workflows/test.yaml?query=branch%3Amaster) [![Coverage](https://img.shields.io/codecov/c/github/boromir674/cookiecutter-python-package/master?logo=codecov)](https://app.codecov.io/gh/boromir674/cookiecutter-python-package) [![Docs](https://img.shields.io/readthedocs/python-package-generator/master?logo=readthedocs&logoColor=lightblue)](https://python-package-generator.readthedocs.io/en/master/) [![Maintainability](https://api.codeclimate.com/v1/badges/1d347d7dfaa134fd944e/maintainability)](https://codeclimate.com/github/boromir674/cookiecutter-python-package/maintainability)
 [![Release Version](https://img.shields.io/pypi/v/cookiecutter_python)](https://pypi.org/project/cookiecutter-python/) [![Wheel](https://img.shields.io/pypi/wheel/cookiecutter-python?color=green&label=wheel)](https://pypi.org/project/cookiecutter-python) [![Tech Debt](https://img.shields.io/codeclimate/tech-debt/boromir674/cookiecutter-python-package)](https://codeclimate.com/github/boromir674/cookiecutter-python-package/) [![Codacy](https://app.codacy.com/project/badge/Grade/5be4a55ff1d34b98b491dc05e030f2d7)](https://app.codacy.com/gh/boromir674/cookiecutter-python-package/dashboard?utm_source=github.com&utm_medium=referral&utm_content=boromir674/cookiecutter-python-package&utm_campaign=Badge_Grade)
 [![Supported Versions](https://img.shields.io/pypi/pyversions/cookiecutter-python?color=blue&label=python&logo=python&logoColor=%23ccccff)](https://pypi.org/project/cookiecutter-python)
-[![PyPI Stats](https://img.shields.io/pypi/dm/cookiecutter-python?logo=pypi&logoColor=%23849ED9&color=%23849ED9)](https://pypistats.org/packages/cookiecutter-python) [![Commits Since Tag](https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/v2.5.9/master?color=blue&logo=github)](https://github.com/boromir674/cookiecutter-python-package/compare/v2.5.9..master) [![Commits Since Release](https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/latest?color=blue&logo=semver&sort=semver)](https://github.com/boromir674/cookiecutter-python-package/releases)
+[![PyPI Stats](https://img.shields.io/pypi/dm/cookiecutter-python?logo=pypi&logoColor=%23849ED9&color=%23849ED9)](https://pypistats.org/packages/cookiecutter-python) [![Commits Since Tag](https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/v2.5.10/master?color=blue&logo=github)](https://github.com/boromir674/cookiecutter-python-package/compare/v2.5.10..master) [![Commits Since Release](https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/latest?color=blue&logo=semver&sort=semver)](https://github.com/boromir674/cookiecutter-python-package/releases)
 [![License](https://img.shields.io/github/license/boromir674/cookiecutter-python-package)](https://github.com/boromir674/cookiecutter-python-package/blob/master/LICENSE) [![OpenSSF](https://bestpractices.coreinfrastructure.org/projects/5988/badge)](https://bestpractices.coreinfrastructure.org/en/projects/5988) [![Ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://docs.astral.sh/ruff/) [![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
 

docs/index.md

@@ -1,6 +1,9 @@
 # Welcome to `Cookiecutter Python Package` Documentation!
 
-**Cookiecutter Python Package**, is an open source project [github.com/boromir674/cookiecutter-python-package](https://github.com/boromir674/cookiecutter-python-package), that **Generates** `Open Source Python Projects`!
+[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/boromir674/cookiecutter-python-package/test.yaml?style=for-the-badge&logo=github%20actions&logoColor=%2365CDCA&label=CI%2FCD&link=https%3A%2F%2Fgithub.com%2Fboromir674%2Fcookiecutter-python-package%2Factions%2Fworkflows%2Ftest.yaml)](https://github.com/boromir674/cookiecutter-python-package/actions/workflows/test.yaml)    [![Read the Docs](https://img.shields.io/readthedocs/python-package-generator?style=for-the-badge&logo=read%20the%20docs&logoColor=%2365CDCA&label=Docs)](https://python-package-generator.readthedocs.io/en/master/)    [![Release Version](https://img.shields.io/pypi/v/cookiecutter_python?style=for-the-badge&logo=pypi&logoColor=%2365CDCA)](https://pypi.org/project/cookiecutter-python/)      [![Coverage](https://img.shields.io/codecov/c/github/boromir674/cookiecutter-python-package/master?style=for-the-badge&logo=codecov&logoColor=%2365CDCA)](https://app.codecov.io/gh/boromir674/cookiecutter-python-package)
+[![PyPI Stats](https://img.shields.io/pypi/dm/cookiecutter-python?logoColor=%2365CDCA&logo=pypi&color=%23849ED9)](https://pypistats.org/packages/cookiecutter-python)     [![Maintainability](https://api.codeclimate.com/v1/badges/1d347d7dfaa134fd944e/maintainability)](https://codeclimate.com/github/boromir674/cookiecutter-python-package/maintainability)      [![Tech Debt](https://img.shields.io/codeclimate/tech-debt/boromir674/cookiecutter-python-package)](https://codeclimate.com/github/boromir674/cookiecutter-python-package/)     [![OpenSSF](https://bestpractices.coreinfrastructure.org/projects/5988/badge)](https://bestpractices.coreinfrastructure.org/en/projects/5988)
+
+**Cookiecutter Python Package**, is an open source project, that **Generates** `Open Source Python Projects`!
 
 ## A few words
 
@@ -156,7 +159,7 @@ and capabilities.
 
     [:octicons-arrow-right-24: :material-language-python: Architecture ](./topics/arch.md)
 
-    [:octicons-arrow-right-24: :material-generator-portable: Generator Process ](./topics/cli_logic.md)
+    [:octicons-arrow-right-24: :material-generator-portable: Generator Process ](./topics/generator_process.md)
 
 
 -   :fontawesome-solid-book-open:{ .lg .middle } __Development Topics__

mkdocs.yml

@@ -60,6 +60,10 @@ plugins:
       nav_file: SUMMARY.md
   - section-index
 
+  # Enable displaying at the bottom of pages the last date of modification!
+  # uv add --optional docs 'mkdocs-git-revision-date-localized-plugin'
+  - git-revision-date-localized
+
 markdown_extensions:
   - mkdocs-click
   - pymdownx.highlight

pyproject.toml

@@ -14,7 +14,7 @@ build-backend = "poetry.core.masonry.api"
 name = "cookiecutter_python"
 ### ... ###
 
-version = "2.5.9"
+version = "2.5.10"
 description = "1-click Generator of Python Project, from Template with streamlined \"DevOps\" using a powerful CI/CD Pipeline."
 readme = "README.md"
 license = "AGPL-3.0-only"
@@ -74,7 +74,7 @@ maintainers = [
 license = {text = "AGPL-3.0-only"}
 
 name = "cookiecutter_python"
-version = "2.5.9"
+version = "2.5.10"
 description = "1-click Generator of Python Project, from Template with streamlined \"DevOps\" using a powerful CI/CD Pipeline."
 readme = "README.md"
 # keywords = []
@@ -121,6 +121,7 @@ docs = [
     "mkdocs-click==0.8.1",
     # latest release (9 May 2025) support python >= 3.7
     "mkdocs-gen-files==0.5.0",
+    "mkdocs-git-revision-date-localized-plugin>=1.4.5, <2.0.0",
     "mkdocs-literate-nav==0.6.1",
     "mkdocs-macros-plugin>=1.3.7, <2.0.0",
     "mkdocs-material>=9.6.12, <10.0.0",

scripts/terminal-based-release.sh

@@ -163,9 +163,50 @@ read -ep "Press any key to make a RELEASE CANDIDATE '${RELEASE_BR}' branch from
 RC_TAG="v${RELEASE_BR}-rc"
 
 git tag -f "$RC_TAG"
-git tag push origin -f "$RC_TAG"
+git push origin -f "$RC_TAG"
 
 echo
 echo "Release Candidate Pipeline Triggered !"
 
-gh run watch
+# press any key to continue
+read -ep "Please watch the CI/CD Pipeline to succeed (press any key to continue to 'live watch') !" -n1 -s
+
+gh run watch
+
+echo "========================="
+echo "Assuming CI/CD Pipeline Succeeded !"
+
+echo "[NEXT] Please run the below to complete merge to 'main'"
+echo
+echo 'gh pr merge --subject "[NEW] Python Project Generator v${NEW_VERSION}" --body "Release v${NEW_VERSION}" --merge'
+
+echo "[IF] prohibitted, you can use --admin flag:"
+echo
+echo 'gh pr merge --admin --subject "[NEW] Python Project Generator v${NEW_VERSION}" --body "Release v${NEW_VERSION}" --merge'
+
+echo
+# press any key to continue
+read -ep "After Merge to '${DEFAULT_BRANCH}' branch is made (ie via CLI or github.com), press any key to proceed with updating local '${DEFAULT_BRANCH}' branch" -n1 -s
+
+echo "========================="
+
+git checkout ${DEFAULT_BRANCH}
+git pull
+
+git tag -f "v${NEW_VERSION}"
+git push origin -f "v${NEW_VERSION}"
+echo
+echo "Release v${NEW_VERSION} is now tagged !"
+echo
+
+# press any key to continue
+read -ep "Please watch the CI/CD Pipeline to succeed (press any key to continue to 'live watch') !" -n1 -s
+
+gh run watch
+
+# after success pypi and docker artifacts pushed !! :-)
+echo
+echo "========================="
+echo "Release v${NEW_VERSION} is now tagged and pushed to PyPi and Docker Hub !"
+echo
+echo " [FINISH] :-)"

src/cookiecutter_python/__init__.py

@@ -1,3 +1,3 @@
-__version__ = '2.5.9'
+__version__ = '2.5.10'
 
 from . import _logging  # noqa