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

{oe_python_template_example-0.0.4 → oe_python_template_example-0.0.8}/.act-env

@@ -1,2 +1,2 @@
-GITLAB_WORKFLOW_RUNTIME=ACT
+GITHUB_WORKFLOW_RUNTIME=ACT
 ACTIONS_RUNTIME_TOKEN=TOKEN

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

@@ -1,4 +1,4 @@
-_commit: v0.2.2
+_commit: v0.3.6
 _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.0.4 → oe_python_template_example-0.0.8}/.devcontainer/devcontainer.json

@@ -21,7 +21,6 @@
 				"charliermarsh.ruff",
 				"codecov.codecov",
 				"donjayamanne.python-environment-manager",
-				"elagil.pre-commit-helper",
 				"fill-labs.dependi",
 				"github.vscode-github-actions",
 				"github.copilot",

{oe_python_template_example-0.0.4 → oe_python_template_example-0.0.8}/.devcontainer/onCreateCommand

@@ -1,7 +1,7 @@
 #!/bin/sh
 
 echo "onCreateCommand: start"
-git config --global --add safe.directory /workspaces/
+git config --global --add safe.directory /workspaces/oe-python-template-example
 rm -rf .nox
 rm -rf .venv
 uv sync --frozen

{oe_python_template_example-0.0.4 → oe_python_template_example-0.0.8}/.github/workflows/package-build-publish-release.yml

@@ -25,7 +25,7 @@ jobs:
         id: git-cliff
         with:
           config: pyproject.toml
-          args: --verbose
+          args: --verbose --latest --strip header
         env:
           OUTPUT: RELEASE_NOTES.md
           GITHUB_REPO: ${{ github.repository }}

{oe_python_template_example-0.0.4 → oe_python_template_example-0.0.8}/.github/workflows/test-and-report.yml

@@ -31,11 +31,6 @@ jobs:
           enable-cache: true
           cache-dependency-glob: uv.lock
 
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 18
-      - run: npm install @modelcontextprotocol/inspector@0.3.0
-
       - name: Install Python, venv and dependencies
         run: |
           uv sync --all-extras --frozen --link-mode=copy
@@ -52,7 +47,7 @@ jobs:
           fi
 
       - name: Print development version info
-        if: s${{ !startsWith(github.ref, 'refs/tags/v') }}
+        if: ${{ !startsWith(github.ref, 'refs/tags/v') }}
         run: |
           TOML_VERSION=$(uv run python -c "import tomli; print(tomli.load(open('pyproject.toml', 'rb'))['project']['version'])")
           echo "Development build - Current version in pyproject.toml: $TOML_VERSION"
@@ -81,7 +76,7 @@ jobs:
 
       - name: Upload test results
         uses: actions/upload-artifact@v4
-        if: ${{ always() && (env.GITLAB_WORKFLOW_RUNTIME != 'ACT') }}
+        if: ${{ always() && (env.GITHUB_WORKFLOW_RUNTIME != 'ACT') }}
         with:
           name: test-results
           path: |
@@ -95,18 +90,18 @@ jobs:
 
       - name: Upload coverage reports to Codecov
         uses: codecov/codecov-action@v5
-        if: ${{ !cancelled() && (env.GITLAB_WORKFLOW_RUNTIME != 'ACT') }}
+        if: ${{ !cancelled() && (env.GITHUB_WORKFLOW_RUNTIME != 'ACT') }}
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           slug: helmut-hoffer-von-ankershoffen/oe-python-template-example
 
       - name: Upload test results to Codecov
-        if: ${{ !cancelled() && (env.GITLAB_WORKFLOW_RUNTIME != 'ACT') }}
+        if: ${{ !cancelled() && (env.GITHUB_WORKFLOW_RUNTIME != 'ACT') }}
         uses: codecov/test-results-action@v1
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
       - name: SonarQube Scan
-        if: ${{ !cancelled() && (env.GITLAB_WORKFLOW_RUNTIME != 'ACT') }}
+        if: ${{ !cancelled() && (env.GITHUB_WORKFLOW_RUNTIME != 'ACT') }}
         uses: SonarSource/sonarqube-scan-action@v4
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

{oe_python_template_example-0.0.4 → oe_python_template_example-0.0.8}/.gitignore

@@ -43,6 +43,7 @@ vulnerabilities.json
 licenses.json
 licenses-inverted.json
 sbom.json
+mypi_junit.xml
 
 # IDE
 .idea/

{oe_python_template_example-0.0.4 → oe_python_template_example-0.0.8}/.pre-commit-config.yaml

@@ -6,6 +6,22 @@ default_install_hook_types:
   - post-rewrite
 fail_fast: true
 repos:
+  - repo: meta
+    hooks:
+      - id: check-useless-excludes
+  - repo: https://github.com/pre-commit/pygrep-hooks
+    rev: v1.10.0
+    hooks:
+      - id: python-check-blanket-noqa
+      - id: python-check-blanket-type-ignore
+      - id: python-check-mock-methods
+      - id: python-no-eval
+      - id: python-no-log-warn
+      - id: python-use-type-annotations
+      - id: rst-backticks
+      - id: rst-directive-colons
+      - id: rst-inline-touching-normal
+      - id: text-unicode-replacement-char
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v5.0.0
     hooks:
@@ -37,16 +53,15 @@ repos:
       - id: name-tests-test
       - id: requirements-txt-fixer
       - id: trailing-whitespace
+        exclude: "docs/source/_static"
   - repo: https://github.com/Yelp/detect-secrets
     rev: v1.5.0
     hooks:
-    -   id: detect-secrets
+      - id: detect-secrets
         args: ['--baseline', '.secrets.baseline']
         additional_dependencies: ["gibberish-detector"]
-        exclude: package.lock.json
   - repo: https://github.com/astral-sh/uv-pre-commit
-    # uv version.
-    rev: 0.5.8
+    rev: 0.6.5
     hooks:
       - id: uv-lock
   - repo: local

{oe_python_template_example-0.0.4 → oe_python_template_example-0.0.8}/.vscode/extensions.json

@@ -3,7 +3,6 @@
         "charliermarsh.ruff",
         "codecov.codecov",
         "donjayamanne.python-environment-manager",
-        "elagil.pre-commit-helper",
         "fill-labs.dependi",
         "github.vscode-github-actions",
         "github.copilot",

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

@@ -3,7 +3,6 @@
         "**/__pycache__ ": true
     },
     "editor.formatOnSave": true,
-    "editor.defaultFormatter": "charliermarsh.ruff",
     "terminal.integrated.scrollback": 100000,
     "[python]": {
         "editor.codeActionsOnSave": {
@@ -40,7 +39,7 @@
     "python.testing.pytestEnabled": true,
     "python.testing.pytestArgs": [
         "-v",
-        "--cov={{ project_name_snake_case }}"
+        "--cov=oe_python_template_example"
     ],
     "github.copilot.selectedCompletionModel": "gpt-4o-copilot",
     "github.copilot.nextEditSuggestions.enabled": true,
@@ -67,9 +66,5 @@
     "sonarlint.connectedMode.project": {
         "connectionId": "helmut-hoffer-von-ankershoffen",
         "projectKey": "helmut-hoffer-von-ankershoffen_oe-python-template-example"
-    },
-    "pre-commit-helper.runOnSave": "fixes",
-    "pre-commit-helper.excludedHookIds": [
-        "nox"
-    ],
-}
+    }
+}

oe_python_template_example-0.0.4/RELEASE_NOTES.md → oe_python_template_example-0.0.8/CHANGELOG.md

@@ -1,5 +1,12 @@
 [🧠 OE Python Template Example](https://oe-python-template-example.readthedocs.io/en/latest/)
 
+## [0.0.7](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/compare/v0.0.4..v0.0.7) - 2025-03-08
+
+### ⚙️ Miscellaneous Tasks
+
+- *(template)* Bump - ([355683b](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/commit/355683b69c3ef67461b9d7a562c71fcd5e048ad9))
+
+
 ## [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

{oe_python_template_example-0.0.4 → oe_python_template_example-0.0.8}/CODEOWNERS

@@ -1,3 +1,3 @@
-# oe_python_template_example code owners
+# oe-python-template-example code owners
 
 [*] @helmut-hoffer-von-ankershoffen # noqa

{oe_python_template_example-0.0.4 → oe_python_template_example-0.0.8}/CONTRIBUTING.md

@@ -111,6 +111,20 @@ docker build -t oe-python-template-example .
 docker run --env THE_VAR=THE_VALUE oe-python-template-example --help
 ```
 
+### Copier
+
+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
+```
+
 ## Pull Request Guidelines
 
 - **Pre-Commit Hooks:** We use pre-commit hooks to ensure code quality. Please install the pre-commit hooks by running `uv run pre-commit install`. This ensure all tests, linting etc. pass locally before you can commit.

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template-example
-Version: 0.0.4
+Version: 0.0.8
 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/
@@ -30,7 +30,7 @@ License: MIT License
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
 License-File: LICENSE
-Keywords: codecov,docker,oe-python-template-example,pydantic,python,ruff,typer,uv
+Keywords: act,codecov,copier,cyclonedx,detect-secrets,devcontainer,docker,git-cliff,jupyter,marimo,mypy,nox,oe-python-template,oe-python-template-example,pip-audit,pip-licenses,pre-commit,pydantic,pypi,pytest,python,readthedocs,ruff,sonarcloud,sonarqube,sphinx,streamlit,typer,uv
 Classifier: Development Status :: 2 - Pre-Alpha
 Classifier: Framework :: Pydantic
 Classifier: Framework :: Pytest
@@ -48,13 +48,15 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Typing :: Typed
 Requires-Python: <4.0,>=3.11
+Requires-Dist: fastapi[all,standard]>=0.115.11
 Requires-Dist: pydantic>=2.10.6
 Requires-Dist: python-dotenv>=1.0.1
 Requires-Dist: typer>=0.15.1
 Provides-Extra: examples
+Requires-Dist: jinja2>=3.1.6; extra == 'examples'
 Requires-Dist: jupyter>=1.1.1; extra == 'examples'
-Requires-Dist: marimo>=0.11.13; extra == 'examples'
-Requires-Dist: streamlit>=1.42.2; extra == 'examples'
+Requires-Dist: marimo>=0.11.17; extra == 'examples'
+Requires-Dist: streamlit>=1.43.1; extra == 'examples'
 Description-Content-Type: text/markdown
 
 # 🧠 OE Python Template Example
@@ -71,13 +73,17 @@ Description-Content-Type: text/markdown
 [![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)
 [![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)
 [![GitHub - Version](https://img.shields.io/github/v/release/helmut-hoffer-von-ankershoffen/oe-python-template-example?label=GitHub&style=flat&labelColor=1C2C2E&color=blue&logo=GitHub&logoColor=white)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/releases)
 [![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/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/)
+[![Docker - Size](https://img.shields.io/docker/image-size/helmuthva/oe-python-template-example?sort=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)
+[![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCI+PHBhdGggZmlsbD0iI2ZmZiIgZD0iTTE3IDE2VjdsLTYgNU0yIDlWOGwxLTFoMWw0IDMgOC04aDFsNCAyIDEgMXYxNGwtMSAxLTQgMmgtMWwtOC04LTQgM0gzbC0xLTF2LTFsMy0zIi8+PC9zdmc+)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example)
+[![Open in GitHub Codespaces](https://img.shields.io/static/v1?label=GitHub%20Codespaces&message=Open&color=blue&logo=github)](https://github.com/codespaces/new/helmut-hoffer-von-ankershoffen/oe-python-template-example)
+
 <!---
 [![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)
 [![ghcr.io - Sze](https://ghcr-badge.egpl.dev/helmut-hoffer-von-ankershoffen/oe-python-template-example/size?color=%2344cc11&tag=latest&label=size&trim=)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/pkgs/container/oe-python-template-example)
@@ -122,7 +128,7 @@ copier copy gh:helmut-hoffer-von-ankershoffen/oe-python-template .
 Step 4: Setup the local environment
 
 ```shell
-uv run nox -s setup_eev
+uv run nox -s setup_dev
 ```
 
 Step 5: Perform inital commit and push
@@ -169,8 +175,8 @@ uvx oe-python-template-example
 The CLI provides extensive help:
 
 ```shell
-uvx oe-python-template-example --help              # all CLI commands
-uvx oe-python-template-example command --help      # all options for command
+uvx oe-python-template-example --help                # all CLI commands
+uvx oe-python-template-example hello-world --help    # help for specific command
 ```
 
 

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

@@ -12,13 +12,17 @@
 [![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)
 [![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)
 [![GitHub - Version](https://img.shields.io/github/v/release/helmut-hoffer-von-ankershoffen/oe-python-template-example?label=GitHub&style=flat&labelColor=1C2C2E&color=blue&logo=GitHub&logoColor=white)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/releases)
 [![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/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/)
+[![Docker - Size](https://img.shields.io/docker/image-size/helmuthva/oe-python-template-example?sort=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)
+[![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCI+PHBhdGggZmlsbD0iI2ZmZiIgZD0iTTE3IDE2VjdsLTYgNU0yIDlWOGwxLTFoMWw0IDMgOC04aDFsNCAyIDEgMXYxNGwtMSAxLTQgMmgtMWwtOC04LTQgM0gzbC0xLTF2LTFsMy0zIi8+PC9zdmc+)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example)
+[![Open in GitHub Codespaces](https://img.shields.io/static/v1?label=GitHub%20Codespaces&message=Open&color=blue&logo=github)](https://github.com/codespaces/new/helmut-hoffer-von-ankershoffen/oe-python-template-example)
+
 <!---
 [![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)
 [![ghcr.io - Sze](https://ghcr-badge.egpl.dev/helmut-hoffer-von-ankershoffen/oe-python-template-example/size?color=%2344cc11&tag=latest&label=size&trim=)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/pkgs/container/oe-python-template-example)
@@ -63,7 +67,7 @@ copier copy gh:helmut-hoffer-von-ankershoffen/oe-python-template .
 Step 4: Setup the local environment
 
 ```shell
-uv run nox -s setup_eev
+uv run nox -s setup_dev
 ```
 
 Step 5: Perform inital commit and push
@@ -110,8 +114,8 @@ uvx oe-python-template-example
 The CLI provides extensive help:
 
 ```shell
-uvx oe-python-template-example --help              # all CLI commands
-uvx oe-python-template-example command --help      # all options for command
+uvx oe-python-template-example --help                # all CLI commands
+uvx oe-python-template-example hello-world --help    # help for specific command
 ```
 
 

oe_python_template_example-0.0.8/RELEASE_NOTES.md

@@ -0,0 +1 @@
+

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

@@ -29,10 +29,10 @@
 
 ## Publishing package to Python Package Index (pypi.org)
 
-1. Execute `uv run build`. This will generate the build files (wheel and tar.gz) in the `dist` folder
+1. Execute `uv build`. This will generate the build files (wheel and tar.gz) in the `dist` folder
 2. Sign-Up at https://pypi.org/
 3. Goto https://pypi.org/manage/account/ and create an API token of scope "Entire account", calling it oe-python-template-example. Copy the value of the token into your clipboard.
-4. Execute `uv run publish`, entering __token__ as username and paste the token from your clipboard as password. This will register your package on PyPI and upload the build files
+4. Execute `uv publish`, entering __token__ as username and paste the token from your clipboard as password. This will register your package on PyPI and upload the build files
 5. Goto https://pypi.org/manage/account/ again and delete the previously created token oe-python-template-example of scope "Entire account".
 6. Now create an new API token, again called oe-python-template-example, but this time of scope "Project: oe-python-template-example". Copy the token into your clipboard.
 7. Goto https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/settings/secrets/actions/new and delete the previously created token.
@@ -60,3 +60,12 @@
 3. Goto https://share.streamlit.io/new and click "Deploy a public app from GitHub"
 4. Select the oe-python-template-example repo, for "Main file path" select `examples/streamlit.py`, for App URL enter `oe-python-template-example`.streamlit.app. Click "Deploy"
 5. Goto https://oe-python-template-example.streamlit.app
+
+## Polishing GitHub repository
+
+1. Goto https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example
+2. Click on the cogs icon in the top right corner next to about
+4. Copy oe-python-template-example.readthedocs.io into the website field
+3. Copy the description from the pyproject.toml file into the description field
+5. Copy up to 20 tags from the pyproject.toml file into the topics field
+6. Goto https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/settings and upload a soclial media image (e.g. logo.png) into the "Social preview" field

oe_python_template_example-0.0.8/VERSION

@@ -0,0 +1 @@
+0.0.8

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

@@ -12,13 +12,17 @@
 [![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)
 [![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)
 [![GitHub - Version](https://img.shields.io/github/v/release/helmut-hoffer-von-ankershoffen/oe-python-template-example?label=GitHub&style=flat&labelColor=1C2C2E&color=blue&logo=GitHub&logoColor=white)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/releases)
 [![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/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/)
+[![Docker - Size](https://img.shields.io/docker/image-size/helmuthva/oe-python-template-example?sort=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)
+[![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCI+PHBhdGggZmlsbD0iI2ZmZiIgZD0iTTE3IDE2VjdsLTYgNU0yIDlWOGwxLTFoMWw0IDMgOC04aDFsNCAyIDEgMXYxNGwtMSAxLTQgMmgtMWwtOC04LTQgM0gzbC0xLTF2LTFsMy0zIi8+PC9zdmc+)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example)
+[![Open in GitHub Codespaces](https://img.shields.io/static/v1?label=GitHub%20Codespaces&message=Open&color=blue&logo=github)](https://github.com/codespaces/new/helmut-hoffer-von-ankershoffen/oe-python-template-example)
+
 <!---
 [![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)
 [![ghcr.io - Sze](https://ghcr-badge.egpl.dev/helmut-hoffer-von-ankershoffen/oe-python-template-example/size?color=%2344cc11&tag=latest&label=size&trim=)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/pkgs/container/oe-python-template-example)

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

@@ -32,7 +32,7 @@ copier copy gh:helmut-hoffer-von-ankershoffen/oe-python-template .
 Step 4: Setup the local environment
 
 ```shell
-uv run nox -s setup_eev
+uv run nox -s setup_dev
 ```
 
 Step 5: Perform inital commit and push
@@ -79,8 +79,8 @@ uvx oe-python-template-example
 The CLI provides extensive help:
 
 ```shell
-uvx oe-python-template-example --help              # all CLI commands
-uvx oe-python-template-example command --help      # all options for command
+uvx oe-python-template-example --help                # all CLI commands
+uvx oe-python-template-example hello-world --help    # help for specific command
 ```
 
 

oe_python_template_example-0.0.8/bump

@@ -0,0 +1,7 @@
+#!/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.0.4 → oe_python_template_example-0.0.8}/compose.yaml

@@ -1,5 +1,5 @@
 services:
-  oe_python_template_example:
+  oe-python-template-example:
     build: .
     env_file:
       - path: .env

oe_python_template_example-0.0.8/docs/source/_static/openapi.json

@@ -0,0 +1,185 @@
+{
+  "openapi": "3.1.0",
+  "info": {
+    "title": "OE Python Template Example",
+    "termsOfService": "https://oe-python-template-example.readthedocs.io/en/latest/",
+    "contact": {
+      "name": "Helmut Hoffer von Ankershoffen",
+      "url": "https://github.com/helmut-hoffer-von-ankershoffen",
+      "email": "helmuthva@gmail.com"
+    },
+    "version": "1.0.0"
+  },
+  "paths": {
+    "/hello-world": {
+      "get": {
+        "tags": [
+          "Basics"
+        ],
+        "summary": "Hello World",
+        "description": "Return a hello world message.\n\nReturns:\n    HelloWorldResponse: A response containing the hello world message.",
+        "operationId": "hello_world_hello_world_get",
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HelloWorldResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/echo": {
+      "post": {
+        "tags": [
+          "Basics"
+        ],
+        "summary": "Echo",
+        "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": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/EchoRequest"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/EchoResponse"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Validation Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HTTPValidationError"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "EchoRequest": {
+        "properties": {
+          "text": {
+            "type": "string",
+            "minLength": 1,
+            "title": "Text",
+            "description": "The text to echo back",
+            "examples": [
+              "Hello, world!"
+            ]
+          }
+        },
+        "type": "object",
+        "required": [
+          "text"
+        ],
+        "title": "EchoRequest",
+        "description": "Request model for echo endpoint."
+      },
+      "EchoResponse": {
+        "properties": {
+          "message": {
+            "type": "string",
+            "minLength": 1,
+            "title": "Message",
+            "description": "The message content",
+            "examples": [
+              "Hello, world!"
+            ]
+          }
+        },
+        "type": "object",
+        "required": [
+          "message"
+        ],
+        "title": "EchoResponse",
+        "description": "Response model for echo endpoint."
+      },
+      "HTTPValidationError": {
+        "properties": {
+          "detail": {
+            "items": {
+              "$ref": "#/components/schemas/ValidationError"
+            },
+            "type": "array",
+            "title": "Detail"
+          }
+        },
+        "type": "object",
+        "title": "HTTPValidationError"
+      },
+      "HelloWorldResponse": {
+        "properties": {
+          "message": {
+            "type": "string",
+            "title": "Message",
+            "description": "The hello world message",
+            "examples": [
+              "Hello, world!"
+            ]
+          }
+        },
+        "type": "object",
+        "required": [
+          "message"
+        ],
+        "title": "HelloWorldResponse",
+        "description": "Response model for hello-world endpoint."
+      },
+      "ValidationError": {
+        "properties": {
+          "loc": {
+            "items": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "integer"
+                }
+              ]
+            },
+            "type": "array",
+            "title": "Location"
+          },
+          "msg": {
+            "type": "string",
+            "title": "Message"
+          },
+          "type": {
+            "type": "string",
+            "title": "Error Type"
+          }
+        },
+        "type": "object",
+        "required": [
+          "loc",
+          "msg",
+          "type"
+        ],
+        "title": "ValidationError"
+      }
+    }
+  }
+}