oe-python-template-example 0.1.13__tar.gz → 0.1.15__tar.gz

{oe_python_template_example-0.1.13 → oe_python_template_example-0.1.15}/.copier-answers.yml

@@ -1,4 +1,4 @@
-_commit: v0.5.7
+_commit: v0.5.10
 _src_path: gh:helmut-hoffer-von-ankershoffen/oe-python-template
 author_email: helmuthva@gmail.com
 author_github_username: helmut-hoffer-von-ankershoffen

{oe_python_template_example-0.1.13 → oe_python_template_example-0.1.15}/.github/workflows/package-build-publish-release.yml

@@ -53,7 +53,7 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
-          gh release create ${{ github.ref_name }} ./dist/* sbom.json licenses.json licenses-inverted.json vulnerabilities.json --notes-file ${{ steps.git-cliff.outputs.changelog }}
+          gh release create ${{ github.ref_name }} ./dist/* ./reports/* --notes-file ${{ steps.git-cliff.outputs.changelog }}
 
       - name: Allow other workflows to trigger on release
         env:

{oe_python_template_example-0.1.13 → oe_python_template_example-0.1.15}/.gitignore

@@ -41,18 +41,13 @@ develop-eggs/
 .nox
 .dmypy.json
 .mypy_cache/
+.coverage
 
 
-# Build Artefacts
-junit.xml
-.coverage*
-coverage.xml
-coverage_html/
-vulnerabilities.json
-licenses.json
-licenses-inverted.json
-sbom.json
-mypi_junit.xml
+# Build Report
+reports/*
+!reports/.keep
+!reports/README.md
 
 # IDE
 .idea/

{oe_python_template_example-0.1.13 → oe_python_template_example-0.1.15}/CHANGELOG.md

@@ -1,6 +1,13 @@
 [🧠 OE Python Template Example](https://oe-python-template-example.readthedocs.io/en/latest/)
 
-## [0.1.13](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/compare/v0.1.12..0.1.13) - 2025-03-14
+## [0.1.15](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/compare/v0.1.14..0.1.15) - 2025-03-15
+
+### ⚙️ Miscellaneous Tasks
+
+- .gitignore - ([b1fb3fa](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/commit/b1fb3fa01b18031cfa12f3241b62e70dc1419640))
+
+
+## [0.1.13](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/compare/v0.1.12..v0.1.13) - 2025-03-14
 
 ### 📚 Documentation
 

{oe_python_template_example-0.1.13 → oe_python_template_example-0.1.15}/CONTRIBUTING.md

@@ -90,10 +90,28 @@ uv run nox -s audit     # run security and license audit, inc. sbom generation
 uv run nox -s docs      # build documentation, output in docs/build/html
 ```
 
+As a shortcut, you can run build steps using `./n`:
+
+```shell
+./n test
+./n lint
+# ...
+```
+
+Generate a wheel using uv
+```shell
+uv build
+```
+
+Notes:
+1. Reports dumped into ```reports/```
+3. Documentation dumped into ```docs/build/html/```
+2. Distribution dumped into ```dist/```
+
 ### Running GitHub CI workflow locally
 
 ```shell
-./github-action-run.sh
+uv run nox -s act
 ```
 
 Notes:
@@ -116,13 +134,7 @@ docker run --env THE_VAR=THE_VALUE oe-python-template-example --help
 Update scaffold from template
 
 ```shell
-copier update --trust --skip-tasks --skip-answered
-```
-
-### Updating demo application contained within oe-python-template-example
-
-```shell
-copier copy -r HEAD . . --force --trust
+uv run nox -s update_from_template
 ```
 
 ## Pull Request Guidelines

{oe_python_template_example-0.1.13 → oe_python_template_example-0.1.15}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template-example
-Version: 0.1.13
+Version: 0.1.15
 Summary: 🧠 Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
 Project-URL: Homepage, https://oe-python-template-example.readthedocs.io/en/latest/
 Project-URL: Documentation, https://oe-python-template-example.readthedocs.io/en/latest/
@@ -66,13 +66,14 @@ Description-Content-Type: text/markdown
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/oe-python-template-example.svg?logo=python&color=204361&labelColor=1E2933)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/noxfile.py)
 [![CI](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/actions/workflows/test-and-report.yml/badge.svg)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/actions/workflows/test-and-report.yml)
 [![Read the Docs](https://img.shields.io/readthedocs/oe-python-template-example)](https://oe-python-template-example.readthedocs.io/en/latest/)
-[![CodeQL](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/actions/workflows/codeql.yml/badge.svg)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/security/code-scanning)
-[![Dependabot](https://img.shields.io/badge/dependabot-active-brightgreen?style=flat-square&logo=dependabot)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/security/dependabot)
 [![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template-example&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)
 [![Security](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template-example&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)
 [![Maintainability](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template-example&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)
 [![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template-example&metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)
 [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template-example&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)
+[![CodeQL](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/actions/workflows/codeql.yml/badge.svg)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/security/code-scanning)
+[![Dependabot](https://img.shields.io/badge/dependabot-active-brightgreen?style=flat-square&logo=dependabot)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/security/dependabot)
+[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/)
 [![Coverage](https://codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template-example/graph/badge.svg?token=SX34YRP30E)](https://codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template-example)
 [![Ruff](https://img.shields.io/badge/style-Ruff-blue?color=D6FF65)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/noxfile.py)
 [![MyPy](https://img.shields.io/badge/mypy-checked-blue)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/noxfile.py)
@@ -135,13 +136,10 @@ uvx oe-python-template-example serve --port=4711 # serves webservice API on port
 ```
 
 Notes:
+* The API is versioned, mounted at `/api/v1` resp. `/api/v2`
+* While serving the webservice API go to [http://127.0.0.1:8000/api/v1/hello-world](http://127.0.0.1:8000/api/v1/hello-world) to see the respons of the `hello-world` operation.
+* Interactive documentation is provided at [http://127.0.0.1:8000/api/docs](http://127.0.0.1:8000/api/docs)
 
-- The API is versioned, mounted at `/api/v1` resp. `/api/v2`
-- While serving the webservice API go to
-  [http://127.0.0.1:8000/api/v1/hello-world](http://127.0.0.1:8000/api/v1/hello-world)
-  to see the respons of the `hello-world` operation.
-- Interactive documentation is provided at
-  [http://127.0.0.1:8000/api/docs](http://127.0.0.1:8000/api/docs)
 
 The CLI provides extensive help:
 

{oe_python_template_example-0.1.13 → oe_python_template_example-0.1.15}/README.md

@@ -5,13 +5,14 @@
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/oe-python-template-example.svg?logo=python&color=204361&labelColor=1E2933)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/noxfile.py)
 [![CI](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/actions/workflows/test-and-report.yml/badge.svg)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/actions/workflows/test-and-report.yml)
 [![Read the Docs](https://img.shields.io/readthedocs/oe-python-template-example)](https://oe-python-template-example.readthedocs.io/en/latest/)
-[![CodeQL](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/actions/workflows/codeql.yml/badge.svg)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/security/code-scanning)
-[![Dependabot](https://img.shields.io/badge/dependabot-active-brightgreen?style=flat-square&logo=dependabot)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/security/dependabot)
 [![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template-example&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)
 [![Security](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template-example&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)
 [![Maintainability](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template-example&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)
 [![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template-example&metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)
 [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template-example&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)
+[![CodeQL](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/actions/workflows/codeql.yml/badge.svg)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/security/code-scanning)
+[![Dependabot](https://img.shields.io/badge/dependabot-active-brightgreen?style=flat-square&logo=dependabot)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/security/dependabot)
+[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/)
 [![Coverage](https://codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template-example/graph/badge.svg?token=SX34YRP30E)](https://codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template-example)
 [![Ruff](https://img.shields.io/badge/style-Ruff-blue?color=D6FF65)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/noxfile.py)
 [![MyPy](https://img.shields.io/badge/mypy-checked-blue)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/noxfile.py)
@@ -74,13 +75,10 @@ uvx oe-python-template-example serve --port=4711 # serves webservice API on port
 ```
 
 Notes:
+* The API is versioned, mounted at `/api/v1` resp. `/api/v2`
+* While serving the webservice API go to [http://127.0.0.1:8000/api/v1/hello-world](http://127.0.0.1:8000/api/v1/hello-world) to see the respons of the `hello-world` operation.
+* Interactive documentation is provided at [http://127.0.0.1:8000/api/docs](http://127.0.0.1:8000/api/docs)
 
-- The API is versioned, mounted at `/api/v1` resp. `/api/v2`
-- While serving the webservice API go to
-  [http://127.0.0.1:8000/api/v1/hello-world](http://127.0.0.1:8000/api/v1/hello-world)
-  to see the respons of the `hello-world` operation.
-- Interactive documentation is provided at
-  [http://127.0.0.1:8000/api/docs](http://127.0.0.1:8000/api/docs)
 
 The CLI provides extensive help:
 

oe_python_template_example-0.1.15/RELEASE_NOTES.md

@@ -0,0 +1,8 @@
+## [0.1.15](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/compare/v0.1.14..v0.1.15) - 2025-03-15
+
+### ⚙️ Miscellaneous Tasks
+
+- .gitignore - ([b1fb3fa](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/commit/b1fb3fa01b18031cfa12f3241b62e70dc1419640))
+
+
+

{oe_python_template_example-0.1.13 → oe_python_template_example-0.1.15}/SECURITY.md

@@ -22,12 +22,12 @@ OE Python Template Example employs several automated tools to continuously monit
 
 - **GitHub Dependabot**: Monitors dependencies for known vulnerabilities and automatically creates pull requests to update them when security issues are found. [Dependendabot alerts](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/security/dependabot) published.
 - **Renovate Bot**: Automatically creates pull requests to update dependencies when new versions are available, with a focus on security patches. [Dependency Dashboard](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/issues) published.
-- **pip-audit**: Regularly scans Python dependencies for known vulnerabilities using data from the Python Advisory Database. ```vulnerabilities.json``` published [per release](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/releases).
+- **pip-audit**: Regularly scans Python dependencies for known vulnerabilities using data from the Python Advisory Database. `vulnerabilities.json` published [per release](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/releases).
 
 ### 2. Dependency Compliance
 
-- **cyclonedx-py**: Generates a Software Bill of Materials (SBOM) in SPDX format, listing all components and dependencies used in the project. ```sbom.json``` (SPDX format) published [per release](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/releases).
-- **pip-licenses**: Exports the licenses of all dependencies to ensure compliance with licensing requirements and avoid using components with problematic licenses. ```licenses.json``` and ```licenses-inverted.json``` published [per release](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/releases).
+- **cyclonedx-py**: Generates a Software Bill of Materials (SBOM) in SPDX format, listing all components and dependencies used in the project. `sbom.json` (SPDX format) published [per release](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/releases).
+- **pip-licenses**: Exports the licenses of all dependencies to ensure compliance with licensing requirements and avoid using components with problematic licenses. `licenses.csv`, `licenses.json` and `licenses_grouped.json` published [per release](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/releases).
 
 ### 3. Static Code Analysis
 

oe_python_template_example-0.1.15/VERSION

@@ -0,0 +1 @@
+0.1.15

{oe_python_template_example-0.1.13 → oe_python_template_example-0.1.15}/_readme_header.md

@@ -5,13 +5,14 @@
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/oe-python-template-example.svg?logo=python&color=204361&labelColor=1E2933)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/noxfile.py)
 [![CI](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/actions/workflows/test-and-report.yml/badge.svg)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/actions/workflows/test-and-report.yml)
 [![Read the Docs](https://img.shields.io/readthedocs/oe-python-template-example)](https://oe-python-template-example.readthedocs.io/en/latest/)
-[![CodeQL](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/actions/workflows/codeql.yml/badge.svg)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/security/code-scanning)
-[![Dependabot](https://img.shields.io/badge/dependabot-active-brightgreen?style=flat-square&logo=dependabot)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/security/dependabot)
 [![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template-example&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)
 [![Security](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template-example&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)
 [![Maintainability](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template-example&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)
 [![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template-example&metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)
 [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template-example&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)
+[![CodeQL](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/actions/workflows/codeql.yml/badge.svg)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/security/code-scanning)
+[![Dependabot](https://img.shields.io/badge/dependabot-active-brightgreen?style=flat-square&logo=dependabot)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/security/dependabot)
+[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/)
 [![Coverage](https://codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template-example/graph/badge.svg?token=SX34YRP30E)](https://codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template-example)
 [![Ruff](https://img.shields.io/badge/style-Ruff-blue?color=D6FF65)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/noxfile.py)
 [![MyPy](https://img.shields.io/badge/mypy-checked-blue)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/noxfile.py)

{oe_python_template_example-0.1.13 → oe_python_template_example-0.1.15}/_readme_main.md

@@ -33,13 +33,10 @@ uvx oe-python-template-example serve --port=4711 # serves webservice API on port
 ```
 
 Notes:
+* The API is versioned, mounted at `/api/v1` resp. `/api/v2`
+* While serving the webservice API go to [http://127.0.0.1:8000/api/v1/hello-world](http://127.0.0.1:8000/api/v1/hello-world) to see the respons of the `hello-world` operation.
+* Interactive documentation is provided at [http://127.0.0.1:8000/api/docs](http://127.0.0.1:8000/api/docs)
 
-- The API is versioned, mounted at `/api/v1` resp. `/api/v2`
-- While serving the webservice API go to
-  [http://127.0.0.1:8000/api/v1/hello-world](http://127.0.0.1:8000/api/v1/hello-world)
-  to see the respons of the `hello-world` operation.
-- Interactive documentation is provided at
-  [http://127.0.0.1:8000/api/docs](http://127.0.0.1:8000/api/docs)
 
 The CLI provides extensive help:
 

{oe_python_template_example-0.1.13 → oe_python_template_example-0.1.15}/docs/source/_static/openapi_v1.yaml

@@ -104,9 +104,12 @@ openapi: 3.1.0
 paths:
   /echo:
     post:
-      description: "Echo back the provided text.\n\nArgs:\n    request (EchoRequest):\
-        \ The request containing the text to echo back.\n\nReturns:\n    EchoResponse:\
-        \ A response containing the echoed text.\n\nRaises:\n    422 Unprocessable\
+      description: "Echo back the provided text.\n\nArgs:\n    request 
+(EchoRequest):\
+        \ The request containing the text to echo back.\n\nReturns:\n    
+EchoResponse:\
+        \ A response containing the echoed text.\n\nRaises:\n    422 
+Unprocessable\
         \ Entity: If text is not provided or empty."
       operationId: echo_echo_post
       requestBody:
@@ -133,12 +136,18 @@ paths:
       - Basics
   /health:
     get:
-      description: "Check the health of the service.\n\nThis endpoint returns the\
-        \ health status of the service.\nThe health status can be either UP or DOWN.\n\
-        If the service is healthy, the status will be UP.\nIf the service is unhealthy,\
-        \ the status will be DOWN and a reason will be provided.\nThe response will\
-        \ have a 200 OK status code if the service is healthy,\nand a 500 Internal\
-        \ Server Error status code if the service is unhealthy.\n\nReturns:\n    Health:\
+      description: "Check the health of the service.\n\nThis endpoint returns 
+the\
+        \ health status of the service.\nThe health status can be either UP or 
+DOWN.\n\
+        If the service is healthy, the status will be UP.\nIf the service is 
+unhealthy,\
+        \ the status will be DOWN and a reason will be provided.\nThe response 
+will\
+        \ have a 200 OK status code if the service is healthy,\nand a 500 
+Internal\
+        \ Server Error status code if the service is unhealthy.\n\nReturns:\n   
+Health:\
         \ The health status of the service."
       operationId: health_health_get
       responses:
@@ -153,12 +162,18 @@ paths:
       - Observability
   /healthz:
     get:
-      description: "Check the health of the service.\n\nThis endpoint returns the\
-        \ health status of the service.\nThe health status can be either UP or DOWN.\n\
-        If the service is healthy, the status will be UP.\nIf the service is unhealthy,\
-        \ the status will be DOWN and a reason will be provided.\nThe response will\
-        \ have a 200 OK status code if the service is healthy,\nand a 500 Internal\
-        \ Server Error status code if the service is unhealthy.\n\nReturns:\n    Health:\
+      description: "Check the health of the service.\n\nThis endpoint returns 
+the\
+        \ health status of the service.\nThe health status can be either UP or 
+DOWN.\n\
+        If the service is healthy, the status will be UP.\nIf the service is 
+unhealthy,\
+        \ the status will be DOWN and a reason will be provided.\nThe response 
+will\
+        \ have a 200 OK status code if the service is healthy,\nand a 500 
+Internal\
+        \ Server Error status code if the service is unhealthy.\n\nReturns:\n   
+Health:\
         \ The health status of the service."
       operationId: health_healthz_get
       responses:
@@ -173,7 +188,8 @@ paths:
       - Observability
   /hello-world:
     get:
-      description: "Return a hello world message.\n\nReturns:\n    HelloWorldResponse:\
+      description: "Return a hello world message.\n\nReturns:\n    
+HelloWorldResponse:\
         \ A response containing the hello world message."
       operationId: hello_world_hello_world_get
       responses:

{oe_python_template_example-0.1.13 → oe_python_template_example-0.1.15}/docs/source/_static/openapi_v2.yaml

@@ -104,9 +104,12 @@ openapi: 3.1.0
 paths:
   /echo:
     post:
-      description: "Echo back the provided utterance.\n\nArgs:\n    request (Utterance):\
-        \ The request containing the utterance to echo back.\n\nReturns:\n    EchoResponse:\
-        \ A response containing the echoed utterance.\n\nRaises:\n    422 Unprocessable\
+      description: "Echo back the provided utterance.\n\nArgs:\n    request 
+(Utterance):\
+        \ The request containing the utterance to echo back.\n\nReturns:\n    
+EchoResponse:\
+        \ A response containing the echoed utterance.\n\nRaises:\n    422 
+Unprocessable\
         \ Entity: If utterance is not provided or empty."
       operationId: echo_v2_echo_post
       requestBody:
@@ -133,12 +136,18 @@ paths:
       - Basics
   /health:
     get:
-      description: "Check the health of the service.\n\nThis endpoint returns the\
-        \ health status of the service.\nThe health status can be either UP or DOWN.\n\
-        If the service is healthy, the status will be UP.\nIf the service is unhealthy,\
-        \ the status will be DOWN and a reason will be provided.\nThe response will\
-        \ have a 200 OK status code if the service is healthy,\nand a 500 Internal\
-        \ Server Error status code if the service is unhealthy.\n\nReturns:\n    Health:\
+      description: "Check the health of the service.\n\nThis endpoint returns 
+the\
+        \ health status of the service.\nThe health status can be either UP or 
+DOWN.\n\
+        If the service is healthy, the status will be UP.\nIf the service is 
+unhealthy,\
+        \ the status will be DOWN and a reason will be provided.\nThe response 
+will\
+        \ have a 200 OK status code if the service is healthy,\nand a 500 
+Internal\
+        \ Server Error status code if the service is unhealthy.\n\nReturns:\n   
+Health:\
         \ The health status of the service."
       operationId: health_health_get
       responses:
@@ -153,12 +162,18 @@ paths:
       - Observability
   /healthz:
     get:
-      description: "Check the health of the service.\n\nThis endpoint returns the\
-        \ health status of the service.\nThe health status can be either UP or DOWN.\n\
-        If the service is healthy, the status will be UP.\nIf the service is unhealthy,\
-        \ the status will be DOWN and a reason will be provided.\nThe response will\
-        \ have a 200 OK status code if the service is healthy,\nand a 500 Internal\
-        \ Server Error status code if the service is unhealthy.\n\nReturns:\n    Health:\
+      description: "Check the health of the service.\n\nThis endpoint returns 
+the\
+        \ health status of the service.\nThe health status can be either UP or 
+DOWN.\n\
+        If the service is healthy, the status will be UP.\nIf the service is 
+unhealthy,\
+        \ the status will be DOWN and a reason will be provided.\nThe response 
+will\
+        \ have a 200 OK status code if the service is healthy,\nand a 500 
+Internal\
+        \ Server Error status code if the service is unhealthy.\n\nReturns:\n   
+Health:\
         \ The health status of the service."
       operationId: health_healthz_get
       responses:
@@ -173,7 +188,8 @@ paths:
       - Observability
   /hello-world:
     get:
-      description: "Return a hello world message.\n\nReturns:\n    HelloWorldResponse:\
+      description: "Return a hello world message.\n\nReturns:\n    
+HelloWorldResponse:\
         \ A response containing the hello world message."
       operationId: hello_world_hello_world_get
       responses:

{oe_python_template_example-0.1.13 → oe_python_template_example-0.1.15}/docs/source/conf.py

@@ -29,7 +29,7 @@ extensions = [
 project = "oe-python-template-example"
 author = "Helmut Hoffer von Ankershoffen"
 copyright = f" (c) 2025-{datetime.now(UTC).year}, {author}"  # noqa: A001
-version = "0.1.13"
+version = "0.1.15"
 release = version
 github_username = "helmut-hoffer-von-ankershoffen"
 github_repository = "oe-python-template-example"

{oe_python_template_example-0.1.13 → oe_python_template_example-0.1.15}/docs/source/index.rst

@@ -14,8 +14,9 @@
    api_v1
    api_v2
    reference
-   release-notes
    contributing
+   security
+   release-notes
 
 .. sidebar-links::
    :caption: Links

oe_python_template_example-0.1.15/docs/source/security.rst

@@ -0,0 +1 @@
+.. mdinclude:: ../../SECURITY.md

oe_python_template_example-0.1.15/n

@@ -0,0 +1,27 @@
+#!/bin/sh
+# Wrapper script for running nox tasks with uv.
+# Allows simpler commands: `./n <session>` instead of `uv run nox -s <session>`
+
+if [ $# -lt 1 ]; then
+echo "Usage: ./n <session_name> [additional_args]"
+    echo "Examples:"
+    echo " ./n setup_dev"
+    echo " ./n lint"
+    echo " ./n docs"
+    echo " ./n audit"
+    echo " ./n test"
+    echo " ./n act"
+    echo " ./n update_from_template"
+    echo " ./n bump patch"
+    echo " ./n bump minor"
+    echo " ./n bump major"
+    echo " ./n bump x.y.z"
+    exit 1
+    fi
+
+
+    session=$1
+    shift # Remove the first argument, remaining args will be passed through
+
+    # Execute the command, forwarding all output
+    exec uv run nox -s "$session" "$@"

{oe_python_template_example-0.1.13 → oe_python_template_example-0.1.15}/noxfile.py

@@ -2,9 +2,11 @@
 
 import json
 import os
+import re
 from pathlib import Path
 
 import nox
+import tomli
 
 nox.options.reuse_existing_virtualenvs = True
 nox.options.default_venv_backend = "uv"
@@ -80,39 +82,40 @@ def docs(session: nox.Session) -> None:
 @nox.session(python=["3.13"])
 def audit(session: nox.Session) -> None:
     """Run security audit and license checks."""
-    _setup_venv(session)
-    session.run("pip-audit", "-f", "json", "-o", "vulnerabilities.json")
-    session.run("jq", ".", "vulnerabilities.json", external=True)
-    session.run("pip-licenses", "--format=json", "--output-file=licenses.json")
-    session.run("jq", ".", "licenses.json", external=True)
+    _setup_venv(session, True)
+    session.run("pip-audit", "-f", "json", "-o", "reports/vulnerabilities.json")
+    session.run("jq", ".", "reports/vulnerabilities.json", external=True)
+    session.run("pip-licenses", "--format=csv", "--order=license", "--output-file=reports/licenses.csv")
+    session.run("pip-licenses", "--format=json", "--output-file=reports/licenses.json")
+    session.run("jq", ".", "reports/licenses.json", external=True)
     # Read and parse licenses.json
-    licenses_data = json.loads(Path("licenses.json").read_text(encoding="utf-8"))
+    licenses_data = json.loads(Path("reports/licenses.json").read_text(encoding="utf-8"))
 
-    licenses_inverted: dict[str, list[dict[str, str]]] = {}
-    licenses_inverted = {}
+    licenses_grouped: dict[str, list[dict[str, str]]] = {}
+    licenses_grouped = {}
     for pkg in licenses_data:
         license_name = pkg["License"]
         package_info = {"Name": pkg["Name"], "Version": pkg["Version"]}
 
-        if license_name not in licenses_inverted:
-            licenses_inverted[license_name] = []
-        licenses_inverted[license_name].append(package_info)
+        if license_name not in licenses_grouped:
+            licenses_grouped[license_name] = []
+        licenses_grouped[license_name].append(package_info)
 
-    # Write inverted data
-    Path("licenses-inverted.json").write_text(
-        json.dumps(licenses_inverted, indent=2),
+    # Write grouped data
+    Path("reports/licenses_grouped.json").write_text(
+        json.dumps(licenses_grouped, indent=2),
         encoding="utf-8",
     )
-    session.run("jq", ".", "licenses-inverted.json", external=True)
-    session.run("cyclonedx-py", "environment", "-o", "sbom.json")
-    session.run("jq", ".", "sbom.json", external=True)
+    session.run("jq", ".", "reports/licenses_grouped.json", external=True)
+    session.run("cyclonedx-py", "environment", "-o", "reports/sbom.json")
+    session.run("jq", ".", "reports/sbom.json", external=True)
 
 
 @nox.session(python=["3.11", "3.12", "3.13"])
 def test(session: nox.Session) -> None:
     """Run tests with pytest."""
     _setup_venv(session)
-    pytest_args = ["pytest", "--disable-warnings", "--junitxml=junit.xml", "-n", "auto", "--dist", "loadgroup"]
+    pytest_args = ["pytest", "--disable-warnings", "--junitxml=reports/junit.xml", "-n", "auto", "--dist", "loadgroup"]
     if _is_act_environment():
         pytest_args.extend(["-k", NOT_SKIP_WITH_ACT])
     session.run(*pytest_args)
@@ -136,3 +139,57 @@ def setup_dev(session: nox.Session) -> None:
         except Exception:  # noqa: BLE001
             session.log("pre-commit run failed, continuing anyway")
         session.run("git", "add", ".", external=True)
+
+
+@nox.session(default=False)
+def update_from_template(session: nox.Session) -> None:
+    """Update from copier template."""
+    if Path("copier.yaml").is_file() or Path("copier.yml").is_file():
+        # Read the current version from pyproject.toml
+        with Path("pyproject.toml").open("rb") as f:
+            pyproject = tomli.load(f)
+            current_version = pyproject["tool"]["bumpversion"]["current_version"]
+            # In this case the project itself is the template
+            session.run("copier", "copy", "-r", "HEAD", ".", ".", "--force", "--trust", "--skip-tasks", external=True)
+            # Bump the version using the current version from pyproject.toml
+            session.run("bump-my-version", "replace", "--new-version", current_version, "--allow-dirty", external=True)
+    else:
+        # In this case the template has been generated from a template
+        session.run("copier", "update", "--trust", "--skip-answered", "--skip-tasks", external=True)
+
+
+@nox.session(default=False)
+def act(session: nox.Session) -> None:
+    """Run GitHub Actions workflow locally with act."""
+    session.run(
+        "act",
+        "-j",
+        "test",
+        "--env-file",
+        ".act-env-public",
+        "--secret-file",
+        ".act-env-secret",
+        "--container-architecture",
+        "linux/amd64",
+        "-P",
+        "ubuntu-latest=catthehacker/ubuntu:act-latest",
+        "--action-offline-mode",
+        "--container-daemon-socket",
+        "-",
+        external=True,
+    )
+
+
+@nox.session(default=False)
+def bump(session: nox.Session) -> None:
+    """Bump version and push changes to git."""
+    version_part = session.posargs[0] if session.posargs else "patch"
+
+    # Check if the version_part is a specific version (e.g., 1.2.3)
+    if re.match(r"^[0-9]+\.[0-9]+\.[0-9]+$", version_part):
+        session.run("bump-my-version", "bump", "--new-version", version_part, external=True)
+    else:
+        session.run("bump-my-version", "bump", version_part, external=True)
+
+    # Push changes to git
+    session.run("git", "push", external=True)

{oe_python_template_example-0.1.13 → oe_python_template_example-0.1.15}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "oe-python-template-example"
-version = "0.1.13"
+version = "0.1.15"
 description = "🧠 Example project scaffolded and kept up to date with OE Python Template (oe-python-template)."
 readme = "README.md"
 authors = [
@@ -197,8 +197,8 @@ docstring-code-format = true
 [tool.ruff.lint.pydocstyle]
 convention = "google"
 
-[tool.mypy] # https://mypy.readthedocs.io/en/latest/config_file.html
-junit_xml = "mypi_junit.xml"
+[tool.mypy]  # https://mypy.readthedocs.io/en/latest/config_file.html
+junit_xml = "reports/mypy_junit.xml"
 plugins = "pydantic.mypy"
 strict = true
 disallow_subclassing_any = false
@@ -217,7 +217,7 @@ warn_required_dynamic_aliases = true
 warn_untyped_fields = true
 
 [tool.pytest.ini_options]
-addopts = "-v --cov=oe_python_template_example --cov-report=term-missing --cov-report=xml:coverage.xml --cov-report=html:coverage_html"
+addopts = "-v --cov=oe_python_template_example --cov-report=term-missing --cov-report=xml:reports/coverage.xml --cov-report=html:reports/coverage_html"
 testpaths = ["tests"]
 python_files = ["*_test.py"]
 asyncio_mode = "auto"
@@ -242,7 +242,7 @@ source = ["src/"]
 
 
 [tool.bumpversion]
-current_version = "0.1.13"
+current_version = "0.1.15"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"

{oe_python_template_example-0.1.13 → oe_python_template_example-0.1.15}/sonar-project.properties

@@ -1,6 +1,6 @@
 sonar.projectKey=helmut-hoffer-von-ankershoffen_oe-python-template-example
 sonar.organization=helmut-hoffer-von-ankershoffen
-sonar.projectVersion=0.1.13
+sonar.projectVersion=0.1.15
 sonar.projectDescription=🧠 Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
 sonar.links.homepage=https://oe-python-template-example.readthedocs.io/en/latest/
 sonar.links.scm=https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example

{oe_python_template_example-0.1.13 → oe_python_template_example-0.1.15}/uv.lock

@@ -2075,7 +2075,7 @@ wheels = [
 
 [[package]]
 name = "oe-python-template-example"
-version = "0.1.13"
+version = "0.1.15"
 source = { editable = "." }
 dependencies = [
     { name = "fastapi", extra = ["all", "standard"] },

oe_python_template_example-0.1.13/RELEASE_NOTES.md

@@ -1,8 +0,0 @@
-## [0.1.13](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/compare/v0.1.12..v0.1.13) - 2025-03-14
-
-### 📚 Documentation
-
-- Adapt - ([6e99c1d](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/commit/6e99c1d604c8e9fe4094b6a21d95619181ea0d14))
-
-
-

oe_python_template_example-0.1.13/VERSION

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

oe_python_template_example-0.1.13/bump

@@ -1,7 +0,0 @@
-#!/bin/sh
-VERSION_PART=${1:-patch}
-if echo "$VERSION_PART" | grep -qE '^[0-9]+\.[0-9]+\.[0-9]+$'; then
-    uv run bump-my-version bump --new-version "$VERSION_PART" && git push
-else
-    uv run bump-my-version bump "$VERSION_PART" && git push
-fi

oe_python_template_example-0.1.13/docs/source/latexmkrc

@@ -1,11 +0,0 @@
-$latex = 'xelatex --no-pdf ' . $ENV{'LATEXOPTS'} . ' %O %S';
-$pdflatex = 'echo "using custom latexmkrc"; '
-. 'for f in *.tex_; do xelatex -jobname="${f%.*}" -interaction=nonstopmode -recorder "$f"; done; '
-. 'xelatex ' . $ENV{'LATEXOPTS'} . ' %O %S';
-$lualatex = 'lualatex ' . $ENV{'LATEXOPTS'} . ' %O %S';
-$xelatex = 'xelatex --no-pdf ' . $ENV{'LATEXOPTS'} . ' %O %S';
-$makeindex = 'makeindex -s python.ist %O -o %D %S';
-add_cus_dep( "glo", "gls", 0, "makeglo" );
-sub makeglo {
- return system( "makeindex -s gglo.ist -o '$_[0].gls' '$_[0].glo'" );
-}

oe_python_template_example-0.1.13/latexmkrc

@@ -1,11 +0,0 @@
-$latex = 'xelatex --no-pdf ' . $ENV{'LATEXOPTS'} . ' %O %S';
-$pdflatex = 'echo "using custom latexmkrc"; '
-. 'for f in *.tex_; do xelatex -jobname="${f%.*}" -interaction=nonstopmode -recorder "$f"; done; '
-. 'xelatex ' . $ENV{'LATEXOPTS'} . ' %O %S';
-$lualatex = 'lualatex ' . $ENV{'LATEXOPTS'} . ' %O %S';
-$xelatex = 'xelatex --no-pdf ' . $ENV{'LATEXOPTS'} . ' %O %S';
-$makeindex = 'makeindex -s python.ist %O -o %D %S';
-add_cus_dep( "glo", "gls", 0, "makeglo" );
-sub makeglo {
- return system( "makeindex -s gglo.ist -o '$_[0].gls' '$_[0].glo'" );
-}