oe-python-template 0.4.3__tar.gz → 0.4.4__tar.gz

{oe_python_template-0.4.3 → oe_python_template-0.4.4}/.copier-answers.yml

@@ -1,4 +1,4 @@
-_commit: v0.4.2-1-gc84332a
+_commit: v0.4.3-1-g16d5590
 _src_path: .
 author_email: helmuthva@gmail.com
 author_github_username: helmut-hoffer-von-ankershoffen

{oe_python_template-0.4.3 → oe_python_template-0.4.4}/CHANGELOG.md

@@ -1,6 +1,13 @@
 [🧠 OE Python Template](https://oe-python-template.readthedocs.io/en/latest/)
 
-## [0.4.3](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.4.2..0.4.3) - 2025-03-13
+## [0.4.4](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.4.3..0.4.4) - 2025-03-13
+
+### 📚 Documentation
+
+- Link template - ([5927a2d](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/5927a2d4b8cb40d5a97c9b6229f46b83cbf007fa))
+
+
+## [0.4.3](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.4.2..v0.4.3) - 2025-03-13
 
 ### Enh
 

{oe_python_template-0.4.3 → oe_python_template-0.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template
-Version: 0.4.3
+Version: 0.4.4
 Summary: 🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling.
 Project-URL: Homepage, https://oe-python-template.readthedocs.io/en/latest/
 Project-URL: Documentation, https://oe-python-template.readthedocs.io/en/latest/
@@ -91,6 +91,7 @@ Description-Content-Type: text/markdown
 
 > [!TIP]
 > 📚 [Online documentation](https://oe-python-template.readthedocs.io/en/latest/) - 📖 [PDF Manual](https://oe-python-template.readthedocs.io/_/downloads/en/latest/pdf/)
+
 ---
 
 

{oe_python_template-0.4.3 → oe_python_template-0.4.4}/README.md

@@ -30,6 +30,7 @@
 
 > [!TIP]
 > 📚 [Online documentation](https://oe-python-template.readthedocs.io/en/latest/) - 📖 [PDF Manual](https://oe-python-template.readthedocs.io/_/downloads/en/latest/pdf/)
+
 ---
 
 

oe_python_template-0.4.4/RELEASE_NOTES.md

@@ -0,0 +1,8 @@
+## [0.4.4](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.4.3..v0.4.4) - 2025-03-13
+
+### 📚 Documentation
+
+- Link template - ([5927a2d](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/5927a2d4b8cb40d5a97c9b6229f46b83cbf007fa))
+
+
+

oe_python_template-0.4.4/VERSION

@@ -0,0 +1 @@
+0.4.4

{oe_python_template-0.4.3 → oe_python_template-0.4.4}/_readme_header.md

@@ -30,4 +30,5 @@
 
 > [!TIP]
 > 📚 [Online documentation](https://oe-python-template.readthedocs.io/en/latest/) - 📖 [PDF Manual](https://oe-python-template.readthedocs.io/_/downloads/en/latest/pdf/)
+
 ---

{oe_python_template-0.4.3 → oe_python_template-0.4.4}/docs/source/conf.py

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

oe_python_template-0.4.4/examples/notebook.ipynb

@@ -0,0 +1,46 @@
+{
+"cells": [
+{
+"cell_type": "code",
+"execution_count": 1,
+"metadata": {},
+"outputs": [
+{
+"name": "stdout",
+"output_type": "stream",
+"text": [
+"Hello, world! The value of THE_VAR is not defined\n"
+]
+}
+],
+"source": [
+"from oe_python_template import Service\n",
+"\n",
+"service = Service()\n",
+"message = service.get_hello_world()\n",
+"message"
+]
+}
+],
+"metadata": {
+"kernelspec": {
+"display_name": ".venv",
+"language": "python",
+"name": "python3"
+},
+"language_info": {
+"codemirror_mode": {
+"name": "ipython",
+"version": 3
+},
+"file_extension": ".py",
+"mimetype": "text/x-python",
+"name": "python",
+"nbconvert_exporter": "python",
+"pygments_lexer": "ipython3",
+"version": "3.11.6"
+}
+},
+"nbformat": 4,
+"nbformat_minor": 2
+}

{oe_python_template-0.4.3 → oe_python_template-0.4.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "oe-python-template"
-version = "0.4.3"
+version = "0.4.4"
 description = "🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling."
 readme = "README.md"
 authors = [
@@ -245,7 +245,7 @@ source = ["src/"]
 
 
 [tool.bumpversion]
-current_version = "0.4.3"
+current_version = "0.4.4"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"

{oe_python_template-0.4.3 → oe_python_template-0.4.4}/sonar-project.properties

@@ -1,6 +1,6 @@
 sonar.projectKey=helmut-hoffer-von-ankershoffen_oe-python-template
 sonar.organization=helmut-hoffer-von-ankershoffen
-sonar.projectVersion=0.4.3
+sonar.projectVersion=0.4.4
 sonar.projectDescription=🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling.
 sonar.links.homepage=https://oe-python-template.readthedocs.io/en/latest/
 sonar.links.scm=https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template

{oe_python_template-0.4.3 → oe_python_template-0.4.4}/template/_readme_header.md.jinja

@@ -30,4 +30,8 @@
 
 > [!TIP]
 > 📚 [Online documentation](https://{{ readthedocs_project_key}}.readthedocs.io/en/latest/) - 📖 [PDF Manual](https://{{ readthedocs_project_key }}.readthedocs.io/_/downloads/en/latest/pdf/)
+{% if pypi_distribution_name != 'oe-python-template' %}
+> [!NOTE]
+> 🧠 This project was scaffolded using the template [oe-python-template](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template) with [copier](https://copier.readthedocs.io/).
+{% endif %}
 ---

{oe_python_template-0.4.3 → oe_python_template-0.4.4}/template/docs/source/conf.py.jinja

@@ -75,11 +75,11 @@ html_static_path = ["_static"]
 html_logo = "../../logo.png"
 html_theme_options = {
     "announcement": (
-        '<a target="_blank" href="{{ github_repository_url_https }}">GitHub</a> - '  # noqa: E501
-        '<a target="_blank" href="https://pypi.org/project/{{ pypi_distribution_name }}">PyPI</a> - '  # noqa: E501
-        '<a target="_blank" href="https://hub.docker.com/r/{{ docker_io_owner}}/{{ docker_io_image_name }}/tags">Docker</a> - '  # noqa: E501
+        '<a target="_blank" href="{{ github_repository_url_https }}">GitHub</a> - '
+        '<a target="_blank" href="https://pypi.org/project/{{ pypi_distribution_name }}">PyPI</a> - '
+        '<a target="_blank" href="https://hub.docker.com/r/{{ docker_io_owner}}/{{ docker_io_image_name }}/tags">Docker</a> - '
         '<a target="_blank" href="https://sonarcloud.io/summary/new_code?id={{ sonarqube_key }}">SonarQube</a> - '  # noqa: E501
-        '<a target="_blank" href="https://app.codecov.io/gh/{{ github_repository_owner }}/{{ github_repository_name}}">Codecov</a>'  # noqa: E501
+        '<a target="_blank" href="https://app.codecov.io/gh/{{ github_repository_owner }}/{{ github_repository_name}}">Codecov</a>'
     ),
 }
 

oe_python_template-0.4.4/template/examples/notebook.ipynb.jinja

@@ -0,0 +1,46 @@
+{
+"cells": [
+{
+"cell_type": "code",
+"execution_count": 1,
+"metadata": {},
+"outputs": [
+{
+"name": "stdout",
+"output_type": "stream",
+"text": [
+"Hello, world! The value of THE_VAR is not defined\n"
+]
+}
+],
+"source": [
+"from oe_python_template import Service\n",
+"\n",
+"service = Service()\n",
+"message = service.get_hello_world()\n",
+"message"
+]
+}
+],
+"metadata": {
+"kernelspec": {
+"display_name": ".venv",
+"language": "python",
+"name": "python3"
+},
+"language_info": {
+"codemirror_mode": {
+"name": "ipython",
+"version": 3
+},
+"file_extension": ".py",
+"mimetype": "text/x-python",
+"name": "python",
+"nbconvert_exporter": "python",
+"pygments_lexer": "ipython3",
+"version": "3.11.6"
+}
+},
+"nbformat": 4,
+"nbformat_minor": 2
+}

{oe_python_template-0.4.3 → oe_python_template-0.4.4}/template/examples/streamlit.py.jinja

@@ -6,6 +6,7 @@ This module creates a web interface using Streamlit to demonstrate the usage of
 """
 
 import streamlit as st
+
 from {{ project_name_snake_case }} import (
     Service,
     __version__,

{oe_python_template-0.4.3 → oe_python_template-0.4.4}/template/noxfile.py.jinja

@@ -46,10 +46,7 @@ def lint(session: nox.Session) -> None:
         "--check",
         ".",
     )
-    session.run(
-        "mypy",
-        "src"
-    )
+    session.run("mypy", "src")
 
 
 @nox.session(python=["3.13"])
@@ -128,14 +125,14 @@ def setup_dev(session: nox.Session) -> None:
     session.run("ruff", "format", ".", external=True)
     git_dir = Path(".git")
     if git_dir.is_dir():
-        session.run("echo","found .git directory", external=True)
-        session.run("touch",".act-env-secret", external=True)
+        session.run("echo", "found .git directory", external=True)
+        session.run("touch", ".act-env-secret", external=True)
         session.run("pre-commit", "install", external=True)
         with Path(".secrets.baseline").open("w", encoding="utf-8") as out:
             session.run("detect-secrets", "scan", stdout=out, external=True)
         session.run("git", "add", ".", external=True)
         try:
             session.run("pre-commit", external=True)
-        except Exception: # noqa: BLE001
+        except Exception:  # noqa: BLE001
             session.log("pre-commit run failed, continuing anyway")
         session.run("git", "add", ".", external=True)

{oe_python_template-0.4.3 → oe_python_template-0.4.4}/template/src/{{ project_name_snake_case }}/__init__.py.jinja

@@ -5,12 +5,11 @@ from .constants import (
     __project_path__,
     __version__,
 )
-
 from .service import Service
 
 __all__ = [
+    "Service",
     "__project_name__",
     "__project_path__",
     "__version__",
-    "Service",
 ]

{oe_python_template-0.4.3 → oe_python_template-0.4.4}/template/src/{{ project_name_snake_case }}/api.py.jinja

@@ -48,22 +48,22 @@ api = FastAPI(
     terms_of_service="https://{{ readthedocs_project_key }}.readthedocs.io/en/latest/",
     openapi_tags=[
         {
-            'name': 'v1',
+            "name": "v1",
             "description": "API version 1, check link on the right",
-            'externalDocs': {
-                'description': 'sub-docs',
+            "externalDocs": {
+                "description": "sub-docs",
                 "url": f"http://{UVICORN_HOST}:{UVICORN_PORT}/api/v1/docs",
-            }
+            },
         },
         {
-            'name': 'v2',
+            "name": "v2",
             "description": "API version 2, check link on the right",
-            'externalDocs': {
-                'description': 'sub-docs',
+            "externalDocs": {
+                "description": "sub-docs",
                 "url": f"http://{UVICORN_HOST}:{UVICORN_PORT}/api/v2/docs",
-            }
+            },
         },
-    ]
+    ],
 )
 
 api_v1 = FastAPI(
@@ -88,6 +88,7 @@ api_v2 = FastAPI(
     terms_of_service="https://{{ readthedocs_project_key }}.readthedocs.io/en/latest/",
 )
 
+
 class _HealthStatus(StrEnum):
     """Health status enumeration.
 

{oe_python_template-0.4.3 → oe_python_template-0.4.4}/template/tests/api_test.py.jinja

@@ -43,6 +43,7 @@ def test_hello_world_endpoint(client: TestClient) -> None:
     assert response.status_code == 200
     assert response.json()["message"].startswith("Hello, world!")
 
+
 def test_echo_endpoint_valid_input(client: TestClient) -> None:
     """Test that the echo endpoint returns the input text."""
     test_text = "Test message"
@@ -96,6 +97,7 @@ def test_health_endpoint(client: TestClient) -> None:
     assert response.json()["status"] == "UP"
     assert response.json()["reason"] is None
 
+
 @patch("{{ project_name_snake_case }}.api.Service")
 def test_health_endpoint_down(mock_service, client: TestClient) -> None:
     """Test that the health endpoint returns 500 status when service is unhealthy."""

{oe_python_template-0.4.3 → oe_python_template-0.4.4}/uv.lock

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

oe_python_template-0.4.3/RELEASE_NOTES.md

@@ -1,8 +0,0 @@
-## [0.4.3](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.4.2..v0.4.3) - 2025-03-13
-
-### Enh
-
-- *(versioned api)* Central docs entrypoint - ([24fda94](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/24fda9401e864ef66109e701b7f549398282c98b))
-
-
-

oe_python_template-0.4.3/VERSION

@@ -1 +0,0 @@
-0.4.3

oe_python_template-0.4.3/examples/jupyter.ipynb

@@ -1,46 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Hello, world! The value of THE_VAR is not defined\n"
-     ]
-    }
-   ],
-   "source": [
-    "from oe_python_template import Service\n",
-    "\n",
-    "service = Service()\n",
-    "message = service.get_hello_world()\n",
-    "message"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": ".venv",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.11.6"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 2
-}

oe_python_template-0.4.3/examples/notebook.ipynb

@@ -1,46 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Hello, world! The value of THE_VAR is not defined\n"
-     ]
-    }
-   ],
-   "source": [
-    "from oe_python_template import Service\n",
-    "\n",
-    "service = Service()\n",
-    "message = service.get_hello_world()\n",
-    "message"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": ".venv",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.11.6"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 2
-}

oe_python_template-0.4.3/template/examples/notebook.ipynb.jinja

@@ -1,45 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Hello, world! The value of THE_VAR is not defined\n"
-     ]
-    }
-   ],
-   "source": [
-    "from {{ project_name_snake_case }} import Service\n",
-    "service = Service()\n",
-    "message = service.get_hello_world()\n",
-    "message"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": ".venv",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.11.6"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 2
-}

{oe_python_template-0.4.3 → oe_python_template-0.4.4}/template/src/{{ project_name_snake_case }}/cli.py.jinja

@@ -1,9 +1,9 @@
 """CLI (Command Line Interface) of {{ project_name }}."""
 
+import os
 from enum import StrEnum
 from typing import Annotated
 
-import os
 import typer
 import uvicorn
 import yaml