oe-python-template-example 0.1.12__tar.gz → 0.1.14__tar.gz

{oe_python_template_example-0.1.12 → oe_python_template_example-0.1.14}/.copier-answers.yml

@@ -1,4 +1,4 @@
-_commit: v0.5.7
+_commit: v0.5.9
 _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.12 → oe_python_template_example-0.1.14}/.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.12 → oe_python_template_example-0.1.14}/.gitignore

@@ -43,16 +43,10 @@ develop-eggs/
 .mypy_cache/
 
 
-# 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.12 → oe_python_template_example-0.1.14}/CHANGELOG.md

@@ -1,5 +1,12 @@
 [🧠 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..v0.1.13) - 2025-03-14
+
+### 📚 Documentation
+
+- Adapt - ([6e99c1d](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/commit/6e99c1d604c8e9fe4094b6a21d95619181ea0d14))
+
+
 ## [0.1.7](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/compare/v0.1.6..v0.1.7) - 2025-03-14
 
 ### Deps

{oe_python_template_example-0.1.12 → oe_python_template_example-0.1.14}/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.12 → oe_python_template_example-0.1.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template-example
-Version: 0.1.12
+Version: 0.1.14
 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)
@@ -100,64 +101,13 @@ Description-Content-Type: text/markdown
 ---
 
 
-Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
+Example project scaffolded and kept up to date with OE Python Template
+(oe-python-template).
 
 Use Cases:
-1) Fast and easy to use project setup
-2) Consistent update of already scaffolded projects to benefit from new and improved features.
-3) Dummy CLI application and service demonstrating example usage of the generated directory structure and build pipeline
-
-## Scaffolding
-
-**Step 1**: Install uv package manager and copier
-```shell
-if [[ "$OSTYPE" == "darwin"* ]]; then                 # Install dependencies for macOS X
-  if ! command -v brew &> /dev/null; then             ## Install Homebrew if not present
-    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
-  fi
-elif [[ "$OSTYPE" == "linux-gnu"* ]]; then            # Install dependencies for Linux
-  sudo apt-get update -y && sudo apt-get install curl -y # Install curl
-fi
-if ! command -v uvx &> /dev/null; then                # Install uv package manager if not present
-  curl -LsSf https://astral.sh/uv/install.sh | sh
-  source $HOME/.local/bin/env
-fi
-uv tool install copier                                # Install copier as global tool
-```
-
-**Step 2**: Now create an empty repository on GitHubm, clone to your local machine, and change into it's directory.
 
-**Step 3**: Scaffold the project
-```shell
-copier copy gh:helmut-hoffer-von-ankershoffen/oe-python-template .
-```
-**Step 4**: Setup the local environment
-
-```shell
-uv run nox -s setup_dev
-```
-
-**Step 5**: Perform initial commit and push
-```shell
-git add .
-git commit -m "feat: Initial commit"
-git push
-```
-
-Visit your GitHub repository and check the Actions tab. The CI workflow should fail at the SonarQube step,
-as this external service is not yet configured for our new repository.
-
-**Step 6**: Follow the [instructions](SERVICE_CONNECTIONS.md) to wire up
-external services such as Cloudcov, SonarQube Cloud, Read The Docs, Docker.io, GHCR.io and Streamlit Community Cloud.
-
-**Step 7**: Release the first versions
-```shell
-./bump
-```
-Notes:
-* You can remove this section post having successfully scafolded your project.
-* The following sections refer to the dummy application and service provided by this template.
-  Use them as inspiration and adapt them to your own project.
+1. Dummy CLI application and service demonstrating example usage of the
+   directory structure and build pipeline generated by oe-python-template
 
 ## Overview
 
@@ -167,13 +117,17 @@ Adding OE Python Template Example to your project as a dependency is easy.
 uv add oe-python-template-example             # add dependency to your project
 ```
 
-If you don't have uv installed follow [these instructions](https://docs.astral.sh/uv/getting-started/installation/). If you still prefer pip over the modern and fast package manager [uv](https://github.com/astral-sh/uv), you can install the library like this:
+If you don't have uv installed follow
+[these instructions](https://docs.astral.sh/uv/getting-started/installation/).
+If you still prefer pip over the modern and fast package manager
+[uv](https://github.com/astral-sh/uv), you can install the library like this:
 
 ```shell
 pip install oe-python-template-example        # add dependency to your project
 ```
 
-Executing the command line interface (CLI) in an isolated Python environment is just as easy:
+Executing the command line interface (CLI) in an isolated Python environment is
+just as easy:
 
 ```shell
 uvx oe-python-template-example hello-world     # prints "Hello, world! [..]"
@@ -182,8 +136,8 @@ 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.
+* 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)
 
 
@@ -197,27 +151,44 @@ uvx oe-python-template-example openapi --help
 uvx oe-python-template-example serve --help
 ```
 
-
 ## Operational Excellence
 
-This project is designed with operational excellence in mind, using modern Python tooling and practices. It includes:
+This project is designed with operational excellence in mind, using modern
+Python tooling and practices. It includes:
 
-* Various examples demonstrating usage:
+- Various examples demonstrating usage:
   - [Simple Python script](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/script.py)
-  - [Streamlit web application](https://oe-python-template-example.streamlit.app/) deployed on [Streamlit Community Cloud](https://streamlit.io/cloud)
-  - [Jupyter](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/notebook.ipynb) and [Marimo](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/notebook.py) notebook
-* [Complete reference documentation](https://oe-python-template-example.readthedocs.io/en/latest/reference.html) on Read the Docs
-* [Transparent test coverage](https://app.codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template-example) including unit and E2E tests (reported on Codecov)
-* Matrix tested with [multiple python versions](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/noxfile.py) to ensure compatibility (powered by [Nox](https://nox.thea.codes/en/stable/))
-* Compliant with modern linting and formatting standards (powered by [Ruff](https://github.com/astral-sh/ruff))
-* Up-to-date dependencies (monitored by [Renovate](https://github.com/renovatebot/renovate) and [GitHub Dependabot](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/security/dependabot))
-* [A-grade code quality](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example) in security, maintainability, and reliability with low technical debt and codesmell (verified by SonarQube)
-* Additional code security checks using [GitHub CodeQL](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/security/code-scanning)
-* [Security Policy](SECURITY.md)
-* [License](LICENSE) compliant with the Open Source Initiative (OSI)
-* 1-liner for installation and execution of command line interface (CLI) via [uv(x)](https://github.com/astral-sh/uv) or [Docker](https://hub.docker.com/r/helmuthva/oe-python-template-example/tags)
-* Setup for developing inside a [devcontainer](https://code.visualstudio.com/docs/devcontainers/containers) included (supports VSCode and GitHub Codespaces)
-
+  - [Streamlit web application](https://oe-python-template-example.streamlit.app/)
+    deployed on [Streamlit Community Cloud](https://streamlit.io/cloud)
+  - [Jupyter](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/notebook.ipynb)
+    and
+    [Marimo](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/notebook.py)
+    notebook
+- [Complete reference documentation](https://oe-python-template-example.readthedocs.io/en/latest/reference.html)
+  on Read the Docs
+- [Transparent test coverage](https://app.codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template-example)
+  including unit and E2E tests (reported on Codecov)
+- Matrix tested with
+  [multiple python versions](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/noxfile.py)
+  to ensure compatibility (powered by [Nox](https://nox.thea.codes/en/stable/))
+- Compliant with modern linting and formatting standards (powered by
+  [Ruff](https://github.com/astral-sh/ruff))
+- Up-to-date dependencies (monitored by
+  [Renovate](https://github.com/renovatebot/renovate) and
+  [GitHub Dependabot](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/security/dependabot))
+- [A-grade code quality](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)
+  in security, maintainability, and reliability with low technical debt and
+  codesmell (verified by SonarQube)
+- Additional code security checks using
+  [GitHub CodeQL](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/security/code-scanning)
+- [Security Policy](SECURITY.md)
+- [License](LICENSE) compliant with the Open Source Initiative (OSI)
+- 1-liner for installation and execution of command line interface (CLI) via
+  [uv(x)](https://github.com/astral-sh/uv) or
+  [Docker](https://hub.docker.com/r/helmuthva/oe-python-template-example/tags)
+- Setup for developing inside a
+  [devcontainer](https://code.visualstudio.com/docs/devcontainers/containers)
+  included (supports VSCode and GitHub Codespaces)
 
 ## Usage Examples
 
@@ -242,15 +213,19 @@ message = Service.get_hello_world()
 console.print(f"[blue]{message}[/blue]")
 ```
 
-[Show script code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/script.py) - [Read the reference documentation](https://oe-python-template-example.readthedocs.io/en/latest/reference.html)
+[Show script code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/script.py) -
+[Read the reference documentation](https://oe-python-template-example.readthedocs.io/en/latest/reference.html)
 
 ### Streamlit App
 
-Serve the functionality provided by OE Python Template Example in the web by easily integrating the service into a Streamlit application.
+Serve the functionality provided by OE Python Template Example in the web by
+easily integrating the service into a Streamlit application.
 
-[Try it out!](https://oe-python-template-example.streamlit.app) - [Show the code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/streamlit.py)
+[Try it out!](https://oe-python-template-example.streamlit.app) -
+[Show the code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/streamlit.py)
 
 ... or serve the app locally
+
 ```shell
 uv sync --all-extras                                # Install streamlit dependency part of the examples extra, see pyproject.toml
 uv run streamlit run examples/streamlit.py          # Serve on localhost:8501, opens browser
@@ -267,7 +242,9 @@ uv run streamlit run examples/streamlit.py          # Serve on localhost:8501, o
 ```shell
 uv sync --all-extras                                # Install dependencies required for examples such as Juypyter kernel, see pyproject.toml
 ```
-Install the [Jupyter extension for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter)
+
+Install the
+[Jupyter extension for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter)
 
 Click on `examples/notebook.ipynb` in VSCode and run it.
 
@@ -291,9 +268,11 @@ uv run marimo edit examples/notebook.py --watch     # Edit on localhost:2718, op
 
 ... or edit interactively within VSCode
 
-Install the [Marimo extension for VSCode](https://marketplace.visualstudio.com/items?itemName=marimo-team.vscode-marimo)
+Install the
+[Marimo extension for VSCode](https://marketplace.visualstudio.com/items?itemName=marimo-team.vscode-marimo)
 
-Click on `examples/notebook.py` in VSCode and click on the caret next to the Run icon above the code (looks like a pencil) > "Start in marimo editor" (edit).
+Click on `examples/notebook.py` in VSCode and click on the caret next to the Run
+icon above the code (looks like a pencil) > "Start in marimo editor" (edit).
 
 ## Command Line Interface (CLI)
 
@@ -370,7 +349,7 @@ curl http://127.0.0.1:8000/api/v2/docs
 
 ## Extra: Lorem Ipsum
 
-Dolor sit amet, consectetur adipiscing elit. Donec a diam lectus. Sed sit amet ipsum mauris. Maecenas congue ligula ac quam.
+Nothing yet
 
 
 ## Further Reading

{oe_python_template_example-0.1.12 → oe_python_template_example-0.1.14}/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)
@@ -39,64 +40,13 @@
 ---
 
 
-Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
+Example project scaffolded and kept up to date with OE Python Template
+(oe-python-template).
 
 Use Cases:
-1) Fast and easy to use project setup
-2) Consistent update of already scaffolded projects to benefit from new and improved features.
-3) Dummy CLI application and service demonstrating example usage of the generated directory structure and build pipeline
-
-## Scaffolding
-
-**Step 1**: Install uv package manager and copier
-```shell
-if [[ "$OSTYPE" == "darwin"* ]]; then                 # Install dependencies for macOS X
-  if ! command -v brew &> /dev/null; then             ## Install Homebrew if not present
-    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
-  fi
-elif [[ "$OSTYPE" == "linux-gnu"* ]]; then            # Install dependencies for Linux
-  sudo apt-get update -y && sudo apt-get install curl -y # Install curl
-fi
-if ! command -v uvx &> /dev/null; then                # Install uv package manager if not present
-  curl -LsSf https://astral.sh/uv/install.sh | sh
-  source $HOME/.local/bin/env
-fi
-uv tool install copier                                # Install copier as global tool
-```
-
-**Step 2**: Now create an empty repository on GitHubm, clone to your local machine, and change into it's directory.
 
-**Step 3**: Scaffold the project
-```shell
-copier copy gh:helmut-hoffer-von-ankershoffen/oe-python-template .
-```
-**Step 4**: Setup the local environment
-
-```shell
-uv run nox -s setup_dev
-```
-
-**Step 5**: Perform initial commit and push
-```shell
-git add .
-git commit -m "feat: Initial commit"
-git push
-```
-
-Visit your GitHub repository and check the Actions tab. The CI workflow should fail at the SonarQube step,
-as this external service is not yet configured for our new repository.
-
-**Step 6**: Follow the [instructions](SERVICE_CONNECTIONS.md) to wire up
-external services such as Cloudcov, SonarQube Cloud, Read The Docs, Docker.io, GHCR.io and Streamlit Community Cloud.
-
-**Step 7**: Release the first versions
-```shell
-./bump
-```
-Notes:
-* You can remove this section post having successfully scafolded your project.
-* The following sections refer to the dummy application and service provided by this template.
-  Use them as inspiration and adapt them to your own project.
+1. Dummy CLI application and service demonstrating example usage of the
+   directory structure and build pipeline generated by oe-python-template
 
 ## Overview
 
@@ -106,13 +56,17 @@ Adding OE Python Template Example to your project as a dependency is easy.
 uv add oe-python-template-example             # add dependency to your project
 ```
 
-If you don't have uv installed follow [these instructions](https://docs.astral.sh/uv/getting-started/installation/). If you still prefer pip over the modern and fast package manager [uv](https://github.com/astral-sh/uv), you can install the library like this:
+If you don't have uv installed follow
+[these instructions](https://docs.astral.sh/uv/getting-started/installation/).
+If you still prefer pip over the modern and fast package manager
+[uv](https://github.com/astral-sh/uv), you can install the library like this:
 
 ```shell
 pip install oe-python-template-example        # add dependency to your project
 ```
 
-Executing the command line interface (CLI) in an isolated Python environment is just as easy:
+Executing the command line interface (CLI) in an isolated Python environment is
+just as easy:
 
 ```shell
 uvx oe-python-template-example hello-world     # prints "Hello, world! [..]"
@@ -121,8 +75,8 @@ 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.
+* 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)
 
 
@@ -136,27 +90,44 @@ uvx oe-python-template-example openapi --help
 uvx oe-python-template-example serve --help
 ```
 
-
 ## Operational Excellence
 
-This project is designed with operational excellence in mind, using modern Python tooling and practices. It includes:
+This project is designed with operational excellence in mind, using modern
+Python tooling and practices. It includes:
 
-* Various examples demonstrating usage:
+- Various examples demonstrating usage:
   - [Simple Python script](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/script.py)
-  - [Streamlit web application](https://oe-python-template-example.streamlit.app/) deployed on [Streamlit Community Cloud](https://streamlit.io/cloud)
-  - [Jupyter](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/notebook.ipynb) and [Marimo](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/notebook.py) notebook
-* [Complete reference documentation](https://oe-python-template-example.readthedocs.io/en/latest/reference.html) on Read the Docs
-* [Transparent test coverage](https://app.codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template-example) including unit and E2E tests (reported on Codecov)
-* Matrix tested with [multiple python versions](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/noxfile.py) to ensure compatibility (powered by [Nox](https://nox.thea.codes/en/stable/))
-* Compliant with modern linting and formatting standards (powered by [Ruff](https://github.com/astral-sh/ruff))
-* Up-to-date dependencies (monitored by [Renovate](https://github.com/renovatebot/renovate) and [GitHub Dependabot](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/security/dependabot))
-* [A-grade code quality](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example) in security, maintainability, and reliability with low technical debt and codesmell (verified by SonarQube)
-* Additional code security checks using [GitHub CodeQL](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/security/code-scanning)
-* [Security Policy](SECURITY.md)
-* [License](LICENSE) compliant with the Open Source Initiative (OSI)
-* 1-liner for installation and execution of command line interface (CLI) via [uv(x)](https://github.com/astral-sh/uv) or [Docker](https://hub.docker.com/r/helmuthva/oe-python-template-example/tags)
-* Setup for developing inside a [devcontainer](https://code.visualstudio.com/docs/devcontainers/containers) included (supports VSCode and GitHub Codespaces)
-
+  - [Streamlit web application](https://oe-python-template-example.streamlit.app/)
+    deployed on [Streamlit Community Cloud](https://streamlit.io/cloud)
+  - [Jupyter](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/notebook.ipynb)
+    and
+    [Marimo](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/notebook.py)
+    notebook
+- [Complete reference documentation](https://oe-python-template-example.readthedocs.io/en/latest/reference.html)
+  on Read the Docs
+- [Transparent test coverage](https://app.codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template-example)
+  including unit and E2E tests (reported on Codecov)
+- Matrix tested with
+  [multiple python versions](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/noxfile.py)
+  to ensure compatibility (powered by [Nox](https://nox.thea.codes/en/stable/))
+- Compliant with modern linting and formatting standards (powered by
+  [Ruff](https://github.com/astral-sh/ruff))
+- Up-to-date dependencies (monitored by
+  [Renovate](https://github.com/renovatebot/renovate) and
+  [GitHub Dependabot](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/security/dependabot))
+- [A-grade code quality](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)
+  in security, maintainability, and reliability with low technical debt and
+  codesmell (verified by SonarQube)
+- Additional code security checks using
+  [GitHub CodeQL](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/security/code-scanning)
+- [Security Policy](SECURITY.md)
+- [License](LICENSE) compliant with the Open Source Initiative (OSI)
+- 1-liner for installation and execution of command line interface (CLI) via
+  [uv(x)](https://github.com/astral-sh/uv) or
+  [Docker](https://hub.docker.com/r/helmuthva/oe-python-template-example/tags)
+- Setup for developing inside a
+  [devcontainer](https://code.visualstudio.com/docs/devcontainers/containers)
+  included (supports VSCode and GitHub Codespaces)
 
 ## Usage Examples
 
@@ -181,15 +152,19 @@ message = Service.get_hello_world()
 console.print(f"[blue]{message}[/blue]")
 ```
 
-[Show script code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/script.py) - [Read the reference documentation](https://oe-python-template-example.readthedocs.io/en/latest/reference.html)
+[Show script code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/script.py) -
+[Read the reference documentation](https://oe-python-template-example.readthedocs.io/en/latest/reference.html)
 
 ### Streamlit App
 
-Serve the functionality provided by OE Python Template Example in the web by easily integrating the service into a Streamlit application.
+Serve the functionality provided by OE Python Template Example in the web by
+easily integrating the service into a Streamlit application.
 
-[Try it out!](https://oe-python-template-example.streamlit.app) - [Show the code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/streamlit.py)
+[Try it out!](https://oe-python-template-example.streamlit.app) -
+[Show the code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/streamlit.py)
 
 ... or serve the app locally
+
 ```shell
 uv sync --all-extras                                # Install streamlit dependency part of the examples extra, see pyproject.toml
 uv run streamlit run examples/streamlit.py          # Serve on localhost:8501, opens browser
@@ -206,7 +181,9 @@ uv run streamlit run examples/streamlit.py          # Serve on localhost:8501, o
 ```shell
 uv sync --all-extras                                # Install dependencies required for examples such as Juypyter kernel, see pyproject.toml
 ```
-Install the [Jupyter extension for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter)
+
+Install the
+[Jupyter extension for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter)
 
 Click on `examples/notebook.ipynb` in VSCode and run it.
 
@@ -230,9 +207,11 @@ uv run marimo edit examples/notebook.py --watch     # Edit on localhost:2718, op
 
 ... or edit interactively within VSCode
 
-Install the [Marimo extension for VSCode](https://marketplace.visualstudio.com/items?itemName=marimo-team.vscode-marimo)
+Install the
+[Marimo extension for VSCode](https://marketplace.visualstudio.com/items?itemName=marimo-team.vscode-marimo)
 
-Click on `examples/notebook.py` in VSCode and click on the caret next to the Run icon above the code (looks like a pencil) > "Start in marimo editor" (edit).
+Click on `examples/notebook.py` in VSCode and click on the caret next to the Run
+icon above the code (looks like a pencil) > "Start in marimo editor" (edit).
 
 ## Command Line Interface (CLI)
 
@@ -309,7 +288,7 @@ curl http://127.0.0.1:8000/api/v2/docs
 
 ## Extra: Lorem Ipsum
 
-Dolor sit amet, consectetur adipiscing elit. Donec a diam lectus. Sed sit amet ipsum mauris. Maecenas congue ligula ac quam.
+Nothing yet
 
 
 ## Further Reading

{oe_python_template_example-0.1.12 → oe_python_template_example-0.1.14}/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.14/VERSION

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