oe-python-template-example 0.0.2__tar.gz → 0.0.4__tar.gz

{oe_python_template_example-0.0.2 → oe_python_template_example-0.0.4}/.copier-answers.yml

@@ -1,10 +1,10 @@
-_commit: v0.1.4-1-g94fa56b
-_src_path: .
+_commit: v0.2.2
+_src_path: gh:helmut-hoffer-von-ankershoffen/oe-python-template
 author_email: helmuthva@gmail.com
 author_github_username: helmut-hoffer-von-ankershoffen
 author_name: Helmut Hoffer von Ankershoffen
 docker_io_image_name: oe-python-template-example
-docker_io_owner: helmut-hoffer-von-ankershoffen
+docker_io_owner: helmuthva
 github_repository_name: oe-python-template-example
 github_repository_owner: helmut-hoffer-von-ankershoffen
 github_repository_url_https: https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example

{oe_python_template_example-0.0.2 → oe_python_template_example-0.0.4}/.github/workflows/docker-image-build-publish.yml

@@ -7,7 +7,7 @@ on:
 
 env:
   REGISTRY: docker.io
-  IMAGE_NAME: helmut-hoffer-von-ankershoffen/oe-python-template-example
+  IMAGE_NAME: helmuthva/oe-python-template-example
 
 
 jobs:

{oe_python_template_example-0.0.2 → oe_python_template_example-0.0.4}/.vscode/settings.json

@@ -65,8 +65,8 @@
     "github.copilot.chat.generateTests.codeLens": true,
     "github.copilot.chat.search.semanticTextResults": true,
     "sonarlint.connectedMode.project": {
-        "connectionId": "{{ org_name_kebab_case }}",
-        "projectKey": "{{ org_name_kebab_case }}_{{ project_name_kebab_case }}"
+        "connectionId": "helmut-hoffer-von-ankershoffen",
+        "projectKey": "helmut-hoffer-von-ankershoffen_oe-python-template-example"
     },
     "pre-commit-helper.runOnSave": "fixes",
     "pre-commit-helper.excludedHookIds": [

oe_python_template_example-0.0.4/CHANGELOG.md

@@ -0,0 +1,32 @@
+[🧠 OE Python Template Example](https://oe-python-template-example.readthedocs.io/en/latest/)
+
+## [0.0.4](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/compare/v0.0.3..0.0.4) - 2025-03-02
+
+### 📚 Documentation
+
+- Update - ([45fbb4d](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/commit/45fbb4d287dc8575bbe5895f14f52186a42e8c56))
+
+
+## [0.0.3](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/compare/v0.0.2..v0.0.3) - 2025-03-02
+
+### ⚙️ Miscellaneous Tasks
+
+- Docker.io username - ([afc5d08](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/commit/afc5d08c6ccc5f6c6c3824600c4e0fdef1690154))
+- Copier from repo - ([fa01793](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/commit/fa017930245289f795bbfe9a3204f75103fd19bc))
+
+
+## [0.0.2] - 2025-03-02
+
+### ⛰️  Features
+
+- Initial commit - ([7986b87](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/commit/7986b87fef683b0274acc87c6a11404f13de874e))
+
+### ⚙️ Miscellaneous Tasks
+
+- Bump - ([21554f6](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/commit/21554f61f5cee12c9595b71381888bfa281c8005))
+
+## New Contributors ❤️
+
+* @helmut-hoffer-von-ankershoffen made their first contribution
+
+

{oe_python_template_example-0.0.2 → oe_python_template_example-0.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template-example
-Version: 0.0.2
+Version: 0.0.4
 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/
@@ -75,8 +75,8 @@ Description-Content-Type: text/markdown
 [![GitHub - Commits](https://img.shields.io/github/commit-activity/m/helmut-hoffer-von-ankershoffen/oe-python-template-example/main?label=commits&style=flat&labelColor=1C2C2E&color=blue&logo=GitHub&logoColor=white)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/commits/main/)
 [![PyPI - Version](https://img.shields.io/pypi/v/oe-python-template-example.svg?label=PyPI&logo=pypi&logoColor=%23FFD243&labelColor=%230073B7&color=FDFDFD)](https://pypi.python.org/pypi/oe-python-template-example)
 [![PyPI - Status](https://img.shields.io/pypi/status/oe-python-template-example?logo=pypi&logoColor=%23FFD243&labelColor=%230073B7&color=FDFDFD)](https://pypi.python.org/pypi/oe-python-template-example)
-[![Docker - Version](https://img.shields.io/docker/v/helmut-hoffer-von-ankershoffen/oe-python-template-example?sort=semver&label=Docker&logo=docker&logoColor=white&labelColor=1354D4&color=10151B)](https://hub.docker.com/r/helmut-hoffer-von-ankershoffen/oe-python-template-example/tags)
-[![Docker - Size](https://img.shields.io/docker/image-size/helmut-hoffer-von-ankershoffen/oe-python-template-examplesort=semver&arch=arm64&label=image&logo=docker&logoColor=white&labelColor=1354D4&color=10151B)](https://hub.docker.com/r/helmut-hoffer-von-ankershoffen/oe-python-template-example/)
+[![Docker - Version](https://img.shields.io/docker/v/helmuthva/oe-python-template-example?sort=semver&label=Docker&logo=docker&logoColor=white&labelColor=1354D4&color=10151B)](https://hub.docker.com/r/helmuthva/oe-python-template-example/tags)
+[![Docker - Size](https://img.shields.io/docker/image-size/helmuthva/oe-python-template-examplesort=semver&arch=arm64&label=image&logo=docker&logoColor=white&labelColor=1354D4&color=10151B)](https://hub.docker.com/r/helmuthva/oe-python-template-example/)
 [![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-orange.json)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template)
 <!---
 [![ghcr.io - Version](https://ghcr-badge.egpl.dev/helmut-hoffer-von-ankershoffen/oe-python-template-example/tags?color=%2344cc11&ignore=0.0%2C0%2Clatest&n=3&label=ghcr.io&trim=)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/pkgs/container/oe-python-template-example)
@@ -91,9 +91,60 @@ Description-Content-Type: text/markdown
 Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
 
 Use Cases:
-1) Lorem Ipsum
-2) Dolor Sit Amet
-3) Consectetur Adipiscing Elit
+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 Instructions
+
+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 repo on GitHub and clone it to your local machine in a directory of your choice. Change to that 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_eev
+```
+
+Step 5: Perform inital commit and push
+```shell
+git add .
+git commit -m "feat: Initial commit"
+```
+
+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 in SERVICE_CONNECTIONS.md to setup the connections to 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.
 
 ## Overview
 
@@ -122,6 +173,7 @@ uvx oe-python-template-example --help              # all CLI commands
 uvx oe-python-template-example command --help      # all options for command
 ```
 
+
 ## Highlights
 
 * Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
@@ -135,9 +187,10 @@ uvx oe-python-template-example command --help      # all options for command
 * 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))
 * [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 low codesmell (verified by SonarQube)
-* 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/helmut-hoffer-von-ankershoffen/oe-python-template-example/tags)
+* 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
 
 ### Minimal Python Script:
@@ -245,16 +298,16 @@ Now run the usage examples again.
 You can as well run the CLI within Docker.
 
 ```shell
-docker run helmut-hoffer-von-ankershoffen/oe-python-template-example --help
-docker run helmut-hoffer-von-ankershoffen/oe-python-template-example hello-world
-docker run helmut-hoffer-von-ankershoffen/oe-python-template-example hello-world --json
-docker run helmut-hoffer-von-ankershoffen/oe-python-template-example echo "Lorem"
+docker run helmuthva/oe-python-template-example --help
+docker run helmuthva/oe-python-template-example hello-world
+docker run helmuthva/oe-python-template-example hello-world --json
+docker run helmuthva/oe-python-template-example echo "Lorem"
 ```
 
 Execute command:
 
 ```shell
-docker run --env THE_VAR=MY_VALUE helmut-hoffer-von-ankershoffen/oe-python-template-example echo "Lorem Ipsum"
+docker run --env THE_VAR=MY_VALUE helmuthva/oe-python-template-example echo "Lorem Ipsum"
 ```
 
 Or use docker compose

{oe_python_template_example-0.0.2 → oe_python_template_example-0.0.4}/README.md

@@ -16,8 +16,8 @@
 [![GitHub - Commits](https://img.shields.io/github/commit-activity/m/helmut-hoffer-von-ankershoffen/oe-python-template-example/main?label=commits&style=flat&labelColor=1C2C2E&color=blue&logo=GitHub&logoColor=white)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/commits/main/)
 [![PyPI - Version](https://img.shields.io/pypi/v/oe-python-template-example.svg?label=PyPI&logo=pypi&logoColor=%23FFD243&labelColor=%230073B7&color=FDFDFD)](https://pypi.python.org/pypi/oe-python-template-example)
 [![PyPI - Status](https://img.shields.io/pypi/status/oe-python-template-example?logo=pypi&logoColor=%23FFD243&labelColor=%230073B7&color=FDFDFD)](https://pypi.python.org/pypi/oe-python-template-example)
-[![Docker - Version](https://img.shields.io/docker/v/helmut-hoffer-von-ankershoffen/oe-python-template-example?sort=semver&label=Docker&logo=docker&logoColor=white&labelColor=1354D4&color=10151B)](https://hub.docker.com/r/helmut-hoffer-von-ankershoffen/oe-python-template-example/tags)
-[![Docker - Size](https://img.shields.io/docker/image-size/helmut-hoffer-von-ankershoffen/oe-python-template-examplesort=semver&arch=arm64&label=image&logo=docker&logoColor=white&labelColor=1354D4&color=10151B)](https://hub.docker.com/r/helmut-hoffer-von-ankershoffen/oe-python-template-example/)
+[![Docker - Version](https://img.shields.io/docker/v/helmuthva/oe-python-template-example?sort=semver&label=Docker&logo=docker&logoColor=white&labelColor=1354D4&color=10151B)](https://hub.docker.com/r/helmuthva/oe-python-template-example/tags)
+[![Docker - Size](https://img.shields.io/docker/image-size/helmuthva/oe-python-template-examplesort=semver&arch=arm64&label=image&logo=docker&logoColor=white&labelColor=1354D4&color=10151B)](https://hub.docker.com/r/helmuthva/oe-python-template-example/)
 [![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-orange.json)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template)
 <!---
 [![ghcr.io - Version](https://ghcr-badge.egpl.dev/helmut-hoffer-von-ankershoffen/oe-python-template-example/tags?color=%2344cc11&ignore=0.0%2C0%2Clatest&n=3&label=ghcr.io&trim=)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/pkgs/container/oe-python-template-example)
@@ -32,9 +32,60 @@
 Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
 
 Use Cases:
-1) Lorem Ipsum
-2) Dolor Sit Amet
-3) Consectetur Adipiscing Elit
+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 Instructions
+
+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 repo on GitHub and clone it to your local machine in a directory of your choice. Change to that 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_eev
+```
+
+Step 5: Perform inital commit and push
+```shell
+git add .
+git commit -m "feat: Initial commit"
+```
+
+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 in SERVICE_CONNECTIONS.md to setup the connections to 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.
 
 ## Overview
 
@@ -63,6 +114,7 @@ uvx oe-python-template-example --help              # all CLI commands
 uvx oe-python-template-example command --help      # all options for command
 ```
 
+
 ## Highlights
 
 * Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
@@ -76,9 +128,10 @@ uvx oe-python-template-example command --help      # all options for command
 * 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))
 * [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 low codesmell (verified by SonarQube)
-* 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/helmut-hoffer-von-ankershoffen/oe-python-template-example/tags)
+* 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
 
 ### Minimal Python Script:
@@ -186,16 +239,16 @@ Now run the usage examples again.
 You can as well run the CLI within Docker.
 
 ```shell
-docker run helmut-hoffer-von-ankershoffen/oe-python-template-example --help
-docker run helmut-hoffer-von-ankershoffen/oe-python-template-example hello-world
-docker run helmut-hoffer-von-ankershoffen/oe-python-template-example hello-world --json
-docker run helmut-hoffer-von-ankershoffen/oe-python-template-example echo "Lorem"
+docker run helmuthva/oe-python-template-example --help
+docker run helmuthva/oe-python-template-example hello-world
+docker run helmuthva/oe-python-template-example hello-world --json
+docker run helmuthva/oe-python-template-example echo "Lorem"
 ```
 
 Execute command:
 
 ```shell
-docker run --env THE_VAR=MY_VALUE helmut-hoffer-von-ankershoffen/oe-python-template-example echo "Lorem Ipsum"
+docker run --env THE_VAR=MY_VALUE helmuthva/oe-python-template-example echo "Lorem Ipsum"
 ```
 
 Or use docker compose

oe_python_template_example-0.0.4/RELEASE_NOTES.md

@@ -0,0 +1,32 @@
+[🧠 OE Python Template Example](https://oe-python-template-example.readthedocs.io/en/latest/)
+
+## [0.0.4](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/compare/v0.0.3..v0.0.4) - 2025-03-02
+
+### 📚 Documentation
+
+- Update - ([45fbb4d](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/commit/45fbb4d287dc8575bbe5895f14f52186a42e8c56))
+
+
+## [0.0.3](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/compare/v0.0.2..v0.0.3) - 2025-03-02
+
+### ⚙️ Miscellaneous Tasks
+
+- Docker.io username - ([afc5d08](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/commit/afc5d08c6ccc5f6c6c3824600c4e0fdef1690154))
+- Copier from repo - ([fa01793](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/commit/fa017930245289f795bbfe9a3204f75103fd19bc))
+
+
+## [0.0.2] - 2025-03-02
+
+### ⛰️  Features
+
+- Initial commit - ([7986b87](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/commit/7986b87fef683b0274acc87c6a11404f13de874e))
+
+### ⚙️ Miscellaneous Tasks
+
+- Bump - ([21554f6](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/commit/21554f61f5cee12c9595b71381888bfa281c8005))
+
+## New Contributors ❤️
+
+* @helmut-hoffer-von-ankershoffen made their first contribution
+
+

{oe_python_template_example-0.0.2 → oe_python_template_example-0.0.4}/SERVICE_CONNECTIONS.md

@@ -4,7 +4,7 @@
 
 1. Sign-Up at https://app.codecov.io/
 2. Configure via https://app.codecov.io/gh/helmut-hoffer-von-ankershoffen
-3. Copy value of `CODECOV_TOKEN` into your clipboard
+3. Select (o) Repository token. Copy value of `CODECOV_TOKEN` into your clipboard
 4. Goto https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/settings/secrets/actions/new and create a new repository secret called `CODECOV_TOKEN`, pasting the token from your clipboard as value
 5. Re-run the `CI / test` GitHub job in case you tried before and it failed as Codecov was not yet wired up
 
@@ -21,7 +21,7 @@
 
 ## Generating and publishing documentation via ReadTheDocs (readthedocs.org)
 
-1. Sign-Up at https://readthed§cs.org/
+1. Sign-Up at https://readthedocs.org/
 2. Goto https://app.readthedocs.org/dashboard/import/ and search for your repo by enterin oe-python-template-example in the search bar
 3. Select the repo and click Continue, then Next.
 4. On https://app.readthedocs.org/projects/oe-python-template-example/ wait for the build of the documentation to finish
@@ -42,8 +42,8 @@
 ## Publishing Docker images to Docker Hub (docker.io)
 
 1. Sign-Up at https://hub.docker.com/
-2. Click on your avatar or profile pic and copy the username belwo that into your clipboard.
-3. Goto https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/settings/secrets/actions/new and create a new repository secret called `DOCKER_LOGIN`, setting your username at Docker Hub as the value
+2. Click on your avatar or profile pic and copy the username below that into your clipboard.
+3. Goto https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/settings/secrets/actions/new and create a new repository secret called `DOCKER_USERNAME`, setting your username at Docker Hub as the value
 4. Goto https://app.docker.com/settings/personal-access-tokens/create and create a new access token setting the description to oe-python-template-example, permissions Read & Write & Delete. Copy the value of the token into your clipboard.
 5. Goto https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/settings/secrets/actions/new and create a new repository secret called `DOCKER_PASSWORD`, pasting the token from your clipboard as the value
 6. In case your `CI / test` job passed, and you are ready to release and publish, bump the version of your project by executing `bump`. In case you tried before completing this setup script, you can as well go to https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/actions/workflows/package-build-publish-release.yml, click on the failed job, and re-run.

oe_python_template_example-0.0.4/VERSION

@@ -0,0 +1 @@
+0.0.4

{oe_python_template_example-0.0.2 → oe_python_template_example-0.0.4}/_readme_header.md

@@ -16,8 +16,8 @@
 [![GitHub - Commits](https://img.shields.io/github/commit-activity/m/helmut-hoffer-von-ankershoffen/oe-python-template-example/main?label=commits&style=flat&labelColor=1C2C2E&color=blue&logo=GitHub&logoColor=white)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/commits/main/)
 [![PyPI - Version](https://img.shields.io/pypi/v/oe-python-template-example.svg?label=PyPI&logo=pypi&logoColor=%23FFD243&labelColor=%230073B7&color=FDFDFD)](https://pypi.python.org/pypi/oe-python-template-example)
 [![PyPI - Status](https://img.shields.io/pypi/status/oe-python-template-example?logo=pypi&logoColor=%23FFD243&labelColor=%230073B7&color=FDFDFD)](https://pypi.python.org/pypi/oe-python-template-example)
-[![Docker - Version](https://img.shields.io/docker/v/helmut-hoffer-von-ankershoffen/oe-python-template-example?sort=semver&label=Docker&logo=docker&logoColor=white&labelColor=1354D4&color=10151B)](https://hub.docker.com/r/helmut-hoffer-von-ankershoffen/oe-python-template-example/tags)
-[![Docker - Size](https://img.shields.io/docker/image-size/helmut-hoffer-von-ankershoffen/oe-python-template-examplesort=semver&arch=arm64&label=image&logo=docker&logoColor=white&labelColor=1354D4&color=10151B)](https://hub.docker.com/r/helmut-hoffer-von-ankershoffen/oe-python-template-example/)
+[![Docker - Version](https://img.shields.io/docker/v/helmuthva/oe-python-template-example?sort=semver&label=Docker&logo=docker&logoColor=white&labelColor=1354D4&color=10151B)](https://hub.docker.com/r/helmuthva/oe-python-template-example/tags)
+[![Docker - Size](https://img.shields.io/docker/image-size/helmuthva/oe-python-template-examplesort=semver&arch=arm64&label=image&logo=docker&logoColor=white&labelColor=1354D4&color=10151B)](https://hub.docker.com/r/helmuthva/oe-python-template-example/)
 [![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-orange.json)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template)
 <!---
 [![ghcr.io - Version](https://ghcr-badge.egpl.dev/helmut-hoffer-von-ankershoffen/oe-python-template-example/tags?color=%2344cc11&ignore=0.0%2C0%2Clatest&n=3&label=ghcr.io&trim=)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/pkgs/container/oe-python-template-example)

{oe_python_template_example-0.0.2 → oe_python_template_example-0.0.4}/_readme_main.md

@@ -1,9 +1,60 @@
 Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
 
 Use Cases:
-1) Lorem Ipsum
-2) Dolor Sit Amet
-3) Consectetur Adipiscing Elit
+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 Instructions
+
+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 repo on GitHub and clone it to your local machine in a directory of your choice. Change to that 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_eev
+```
+
+Step 5: Perform inital commit and push
+```shell
+git add .
+git commit -m "feat: Initial commit"
+```
+
+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 in SERVICE_CONNECTIONS.md to setup the connections to 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.
 
 ## Overview
 
@@ -32,6 +83,7 @@ uvx oe-python-template-example --help              # all CLI commands
 uvx oe-python-template-example command --help      # all options for command
 ```
 
+
 ## Highlights
 
 * Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
@@ -45,9 +97,10 @@ uvx oe-python-template-example command --help      # all options for command
 * 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))
 * [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 low codesmell (verified by SonarQube)
-* 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/helmut-hoffer-von-ankershoffen/oe-python-template-example/tags)
+* 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
 
 ### Minimal Python Script:
@@ -155,16 +208,16 @@ Now run the usage examples again.
 You can as well run the CLI within Docker.
 
 ```shell
-docker run helmut-hoffer-von-ankershoffen/oe-python-template-example --help
-docker run helmut-hoffer-von-ankershoffen/oe-python-template-example hello-world
-docker run helmut-hoffer-von-ankershoffen/oe-python-template-example hello-world --json
-docker run helmut-hoffer-von-ankershoffen/oe-python-template-example echo "Lorem"
+docker run helmuthva/oe-python-template-example --help
+docker run helmuthva/oe-python-template-example hello-world
+docker run helmuthva/oe-python-template-example hello-world --json
+docker run helmuthva/oe-python-template-example echo "Lorem"
 ```
 
 Execute command:
 
 ```shell
-docker run --env THE_VAR=MY_VALUE helmut-hoffer-von-ankershoffen/oe-python-template-example echo "Lorem Ipsum"
+docker run --env THE_VAR=MY_VALUE helmuthva/oe-python-template-example echo "Lorem Ipsum"
 ```
 
 Or use docker compose

{oe_python_template_example-0.0.2 → oe_python_template_example-0.0.4}/docs/source/conf.py

@@ -25,7 +25,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.0.2"
+version = "0.0.4"
 release = version
 github_username = "helmut-hoffer-von-ankershoffen"
 github_repository = "oe-python-template-example"
@@ -76,7 +76,7 @@ html_theme_options = {
     "announcement": (
         '<a target="_blank" href="https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example">GitHub</a> - '  # noqa: E501
         '<a target="_blank" href="https://pypi.org/project/oe-python-template-example">PyPI</a> - '
-        '<a target="_blank" href="https://hub.docker.com/r/helmut-hoffer-von-ankershoffen/oe-python-template-example/tags">Docker</a> - '  # noqa: E501
+        '<a target="_blank" href="https://hub.docker.com/r/helmuthva/oe-python-template-example/tags">Docker</a> - '
         '<a target="_blank" href="https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example">SonarQube</a> - '  # noqa: E501
         '<a target="_blank" href="https://app.codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template-example">Codecov</a>'
     ),

{oe_python_template_example-0.0.2 → oe_python_template_example-0.0.4}/docs/source/index.rst

@@ -20,7 +20,7 @@
    :github:
    :pypi: oe-python-template-example
 
-   Docker <https://hub.docker.com/r/helmut-hoffer-von-ankershoffen/oe-python-template-example/tags>
+   Docker <https://hub.docker.com/r/helmuthva/oe-python-template-example/tags>
    SonarQube <https://sonarcloud.io/summary/new_code?id=>
    Codecov <https://app.codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template-example>
    ghcr.io <https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/pkgs/container/oe-python-template-example>

{oe_python_template_example-0.0.2 → oe_python_template_example-0.0.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "oe-python-template-example"
-version = "0.0.2"
+version = "0.0.4"
 description = "🧠 Example project scaffolded and kept up to date with OE Python Template (oe-python-template)."
 readme = "README.md"
 authors = [
@@ -193,7 +193,7 @@ source = ["src/"]
 
 
 [tool.bumpversion]
-current_version = "0.0.2"
+current_version = "0.0.4"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"

{oe_python_template_example-0.0.2 → oe_python_template_example-0.0.4}/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.0.2
+sonar.projectVersion=0.0.4
 sonar.projectDescription=OE Python Template Example
 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.0.2 → oe_python_template_example-0.0.4}/uv.lock

@@ -1927,7 +1927,7 @@ wheels = [
 
 [[package]]
 name = "oe-python-template-example"
-version = "0.0.2"
+version = "0.0.4"
 source = { editable = "." }
 dependencies = [
     { name = "pydantic" },

oe_python_template_example-0.0.2/CHANGELOG.md

@@ -1,17 +0,0 @@
-[🧠 OE Python Template Example](https://oe-python-template-example.readthedocs.io/en/latest/)
-
-## [0.0.2] - 2025-03-02
-
-### ⛰️  Features
-
-- Initial commit - ([7986b87](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/commit/7986b87fef683b0274acc87c6a11404f13de874e))
-
-### ⚙️ Miscellaneous Tasks
-
-- Bump - ([21554f6](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/commit/21554f61f5cee12c9595b71381888bfa281c8005))
-
-## New Contributors ❤️
-
-* @helmut-hoffer-von-ankershoffen made their first contribution
-
-

oe_python_template_example-0.0.2/RELEASE_NOTES.md

@@ -1,17 +0,0 @@
-[🧠 OE Python Template Example](https://oe-python-template-example.readthedocs.io/en/latest/)
-
-## [0.0.2] - 2025-03-02
-
-### ⛰️  Features
-
-- Initial commit - ([7986b87](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/commit/7986b87fef683b0274acc87c6a11404f13de874e))
-
-### ⚙️ Miscellaneous Tasks
-
-- Bump - ([21554f6](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/commit/21554f61f5cee12c9595b71381888bfa281c8005))
-
-## New Contributors ❤️
-
-* @helmut-hoffer-von-ankershoffen made their first contribution
-
-

oe_python_template_example-0.0.2/VERSION

@@ -1 +0,0 @@
-0.0.2