oe-python-template-example 0.1.1__tar.gz → 0.1.4__tar.gz

{oe_python_template_example-0.1.1 → oe_python_template_example-0.1.4}/.copier-answers.yml

@@ -1,4 +1,4 @@
-_commit: v0.4.3
+_commit: v0.4.5
 _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.1 → oe_python_template_example-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template-example
-Version: 0.1.1
+Version: 0.1.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/
@@ -91,6 +91,10 @@ Description-Content-Type: text/markdown
 
 > [!TIP]
 > 📚 [Online documentation](https://oe-python-template-example.readthedocs.io/en/latest/) - 📖 [PDF Manual](https://oe-python-template-example.readthedocs.io/_/downloads/en/latest/pdf/)
+
+> [!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/).
+
 ---
 
 

{oe_python_template_example-0.1.1 → oe_python_template_example-0.1.4}/README.md

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

oe_python_template_example-0.1.4/VERSION

@@ -0,0 +1 @@
+0.1.4

{oe_python_template_example-0.1.1 → oe_python_template_example-0.1.4}/_readme_header.md

@@ -30,4 +30,8 @@
 
 > [!TIP]
 > 📚 [Online documentation](https://oe-python-template-example.readthedocs.io/en/latest/) - 📖 [PDF Manual](https://oe-python-template-example.readthedocs.io/_/downloads/en/latest/pdf/)
+
+> [!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/).
+
 ---

{oe_python_template_example-0.1.1 → oe_python_template_example-0.1.4}/docs/source/_static/openapi_v1.json

@@ -17,7 +17,7 @@
           "Observability"
         ],
         "summary": "Health",
-        "description": "Check the health of the service.\n\nThis endpoint returns the health status of the service.\nThe health status can be either UP or DOWN.\nIf the service is healthy, the status will be UP.\nIf the service is unhealthy, the status will be DOWN and a reason will be provided.\nThe response will have a 200 OK status code if the service is healthy,\nand a 500 Internal Server Error status code if the service is unhealthy.\n\nArgs:\n    service (Annotated[Service, Depends): _description_\n    response (Response): _description_\n\nReturns:\n    Health: The health status of the service.",
+        "description": "Check the health of the service.\n\nThis endpoint returns the health status of the service.\nThe health status can be either UP or DOWN.\nIf the service is healthy, the status will be UP.\nIf the service is unhealthy, the status will be DOWN and a reason will be provided.\nThe response will have a 200 OK status code if the service is healthy,\nand a 500 Internal Server Error status code if the service is unhealthy.\n\nReturns:\n    Health: The health status of the service.",
         "operationId": "health_health_get",
         "responses": {
           "200": {
@@ -39,7 +39,7 @@
           "Observability"
         ],
         "summary": "Health",
-        "description": "Check the health of the service.\n\nThis endpoint returns the health status of the service.\nThe health status can be either UP or DOWN.\nIf the service is healthy, the status will be UP.\nIf the service is unhealthy, the status will be DOWN and a reason will be provided.\nThe response will have a 200 OK status code if the service is healthy,\nand a 500 Internal Server Error status code if the service is unhealthy.\n\nArgs:\n    service (Annotated[Service, Depends): _description_\n    response (Response): _description_\n\nReturns:\n    Health: The health status of the service.",
+        "description": "Check the health of the service.\n\nThis endpoint returns the health status of the service.\nThe health status can be either UP or DOWN.\nIf the service is healthy, the status will be UP.\nIf the service is unhealthy, the status will be DOWN and a reason will be provided.\nThe response will have a 200 OK status code if the service is healthy,\nand a 500 Internal Server Error status code if the service is unhealthy.\n\nReturns:\n    Health: The health status of the service.",
         "operationId": "health_healthz_get",
         "responses": {
           "200": {
@@ -195,7 +195,7 @@
           "status"
         ],
         "title": "Health",
-        "description": "Health status model.\n\nArgs:\n    BaseModel (_type_): _description_"
+        "description": "Health status model."
       },
       "HelloWorldResponse": {
         "properties": {
@@ -255,7 +255,7 @@
           "DOWN"
         ],
         "title": "_HealthStatus",
-        "description": "Health status enumeration.\n\nArgs:\n    StrEnum (_type_): _description_"
+        "description": "Health status enumeration."
       }
     }
   }

{oe_python_template_example-0.1.1 → oe_python_template_example-0.1.4}/docs/source/_static/openapi_v1.yaml

@@ -38,8 +38,7 @@ components:
       title: HTTPValidationError
       type: object
     Health:
-      description: "Health status model.\n\nArgs:\n    BaseModel (_type_): 
-_description_"
+      description: Health status model.
       properties:
         reason:
           anyOf:
@@ -87,8 +86,7 @@ _description_"
       title: ValidationError
       type: object
     _HealthStatus:
-      description: "Health status enumeration.\n\nArgs:\n    StrEnum (_type_): 
-_description_"
+      description: Health status enumeration.
       enum:
       - UP
       - DOWN
@@ -148,11 +146,9 @@ unhealthy,\
 will\
         \ have a 200 OK status code if the service is healthy,\nand a 500 
 Internal\
-        \ Server Error status code if the service is unhealthy.\n\nArgs:\n    
-service\
-        \ (Annotated[Service, Depends): _description_\n    response (Response): 
-_description_\n\
-        \nReturns:\n    Health: The health status of the service."
+        \ Server Error status code if the service is unhealthy.\n\nReturns:\n   
+Health:\
+        \ The health status of the service."
       operationId: health_health_get
       responses:
         '200':
@@ -176,11 +172,9 @@ unhealthy,\
 will\
         \ have a 200 OK status code if the service is healthy,\nand a 500 
 Internal\
-        \ Server Error status code if the service is unhealthy.\n\nArgs:\n    
-service\
-        \ (Annotated[Service, Depends): _description_\n    response (Response): 
-_description_\n\
-        \nReturns:\n    Health: The health status of the service."
+        \ Server Error status code if the service is unhealthy.\n\nReturns:\n   
+Health:\
+        \ The health status of the service."
       operationId: health_healthz_get
       responses:
         '200':

{oe_python_template_example-0.1.1 → oe_python_template_example-0.1.4}/docs/source/_static/openapi_v2.json

@@ -17,7 +17,7 @@
           "Observability"
         ],
         "summary": "Health",
-        "description": "Check the health of the service.\n\nThis endpoint returns the health status of the service.\nThe health status can be either UP or DOWN.\nIf the service is healthy, the status will be UP.\nIf the service is unhealthy, the status will be DOWN and a reason will be provided.\nThe response will have a 200 OK status code if the service is healthy,\nand a 500 Internal Server Error status code if the service is unhealthy.\n\nArgs:\n    service (Annotated[Service, Depends): _description_\n    response (Response): _description_\n\nReturns:\n    Health: The health status of the service.",
+        "description": "Check the health of the service.\n\nThis endpoint returns the health status of the service.\nThe health status can be either UP or DOWN.\nIf the service is healthy, the status will be UP.\nIf the service is unhealthy, the status will be DOWN and a reason will be provided.\nThe response will have a 200 OK status code if the service is healthy,\nand a 500 Internal Server Error status code if the service is unhealthy.\n\nReturns:\n    Health: The health status of the service.",
         "operationId": "health_health_get",
         "responses": {
           "200": {
@@ -39,7 +39,7 @@
           "Observability"
         ],
         "summary": "Health",
-        "description": "Check the health of the service.\n\nThis endpoint returns the health status of the service.\nThe health status can be either UP or DOWN.\nIf the service is healthy, the status will be UP.\nIf the service is unhealthy, the status will be DOWN and a reason will be provided.\nThe response will have a 200 OK status code if the service is healthy,\nand a 500 Internal Server Error status code if the service is unhealthy.\n\nArgs:\n    service (Annotated[Service, Depends): _description_\n    response (Response): _description_\n\nReturns:\n    Health: The health status of the service.",
+        "description": "Check the health of the service.\n\nThis endpoint returns the health status of the service.\nThe health status can be either UP or DOWN.\nIf the service is healthy, the status will be UP.\nIf the service is unhealthy, the status will be DOWN and a reason will be provided.\nThe response will have a 200 OK status code if the service is healthy,\nand a 500 Internal Server Error status code if the service is unhealthy.\n\nReturns:\n    Health: The health status of the service.",
         "operationId": "health_healthz_get",
         "responses": {
           "200": {
@@ -83,7 +83,7 @@
           "Basics"
         ],
         "summary": "Echo V2",
-        "description": "Echo back the provided utterance.\n\nArgs:\n    request (EchoRequestV2): The request containing the utterance to echo back.\n\nReturns:\n    EchoResponse: A response containing the echoed utterance.\n\nRaises:\n    422 Unprocessable Entity: If utterance is not provided or empty.",
+        "description": "Echo back the provided utterance.\n\nArgs:\n    request (Utterance): The request containing the utterance to echo back.\n\nReturns:\n    EchoResponse: A response containing the echoed utterance.\n\nRaises:\n    422 Unprocessable Entity: If utterance is not provided or empty.",
         "operationId": "echo_v2_echo_post",
         "requestBody": {
           "content": {
@@ -176,7 +176,7 @@
           "status"
         ],
         "title": "Health",
-        "description": "Health status model.\n\nArgs:\n    BaseModel (_type_): _description_"
+        "description": "Health status model."
       },
       "HelloWorldResponse": {
         "properties": {
@@ -255,7 +255,7 @@
           "DOWN"
         ],
         "title": "_HealthStatus",
-        "description": "Health status enumeration.\n\nArgs:\n    StrEnum (_type_): _description_"
+        "description": "Health status enumeration."
       }
     }
   }

{oe_python_template_example-0.1.1 → oe_python_template_example-0.1.4}/docs/source/_static/openapi_v2.yaml

@@ -24,8 +24,7 @@ components:
       title: HTTPValidationError
       type: object
     Health:
-      description: "Health status model.\n\nArgs:\n    BaseModel (_type_): 
-_description_"
+      description: Health status model.
       properties:
         reason:
           anyOf:
@@ -87,8 +86,7 @@ _description_"
       title: ValidationError
       type: object
     _HealthStatus:
-      description: "Health status enumeration.\n\nArgs:\n    StrEnum (_type_): 
-_description_"
+      description: Health status enumeration.
       enum:
       - UP
       - DOWN
@@ -107,7 +105,7 @@ paths:
   /echo:
     post:
       description: "Echo back the provided utterance.\n\nArgs:\n    request 
-(EchoRequestV2):\
+(Utterance):\
         \ The request containing the utterance to echo back.\n\nReturns:\n    
 EchoResponse:\
         \ A response containing the echoed utterance.\n\nRaises:\n    422 
@@ -148,11 +146,9 @@ unhealthy,\
 will\
         \ have a 200 OK status code if the service is healthy,\nand a 500 
 Internal\
-        \ Server Error status code if the service is unhealthy.\n\nArgs:\n    
-service\
-        \ (Annotated[Service, Depends): _description_\n    response (Response): 
-_description_\n\
-        \nReturns:\n    Health: The health status of the service."
+        \ Server Error status code if the service is unhealthy.\n\nReturns:\n   
+Health:\
+        \ The health status of the service."
       operationId: health_health_get
       responses:
         '200':
@@ -176,11 +172,9 @@ unhealthy,\
 will\
         \ have a 200 OK status code if the service is healthy,\nand a 500 
 Internal\
-        \ Server Error status code if the service is unhealthy.\n\nArgs:\n    
-service\
-        \ (Annotated[Service, Depends): _description_\n    response (Response): 
-_description_\n\
-        \nReturns:\n    Health: The health status of the service."
+        \ Server Error status code if the service is unhealthy.\n\nReturns:\n   
+Health:\
+        \ The health status of the service."
       operationId: health_healthz_get
       responses:
         '200':

{oe_python_template_example-0.1.1 → oe_python_template_example-0.1.4}/docs/source/api_v2.rst

@@ -1,4 +1,4 @@
-API V1
+API V2
 ======
 
 .. swagger-plugin:: _static/openapi_v2.yaml

{oe_python_template_example-0.1.1 → oe_python_template_example-0.1.4}/docs/source/conf.py

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

oe_python_template_example-0.1.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_example-0.1.1 → oe_python_template_example-0.1.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "oe-python-template-example"
-version = "0.1.1"
+version = "0.1.4"
 description = "🧠 Example project scaffolded and kept up to date with OE Python Template (oe-python-template)."
 readme = "README.md"
 authors = [
@@ -134,10 +134,7 @@ target-version = "py311"
 preview = true
 fix = true
 line-length = 120
-extend-exclude = [
-    ".fixme",
-    "notebook.py"
-]
+extend-exclude = [".fixme", "notebook.py"]
 
 
 [tool.ruff.lint]
@@ -191,7 +188,7 @@ ignore = [
 [tool.ruff.lint.extend-per-file-ignores]
 "examples/notebook.py" = [
     # we are more relaxed in notebooks, while sill applying hundreds of rules
-    "B018",     # notebooks surface variable without print
+    "B018", # notebooks surface variable without print
 ]
 
 [tool.ruff.format]
@@ -200,7 +197,7 @@ docstring-code-format = true
 [tool.ruff.lint.pydocstyle]
 convention = "google"
 
-[tool.mypy]  # https://mypy.readthedocs.io/en/latest/config_file.html
+[tool.mypy] # https://mypy.readthedocs.io/en/latest/config_file.html
 junit_xml = "mypi_junit.xml"
 plugins = "pydantic.mypy"
 strict = true
@@ -213,7 +210,7 @@ show_error_codes = true
 show_error_context = true
 warn_unreachable = true
 
-[tool.pydantic-mypy]  # https://docs.pydantic.dev/latest/integrations/mypy/#configuring-the-plugin
+[tool.pydantic-mypy] # https://docs.pydantic.dev/latest/integrations/mypy/#configuring-the-plugin
 init_forbid_extra = true
 init_typed = true
 warn_required_dynamic_aliases = true
@@ -245,7 +242,7 @@ source = ["src/"]
 
 
 [tool.bumpversion]
-current_version = "0.1.1"
+current_version = "0.1.4"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"

{oe_python_template_example-0.1.1 → oe_python_template_example-0.1.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.1.1
+sonar.projectVersion=0.1.4
 sonar.projectDescription=🧠 Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
 sonar.links.homepage=https://oe-python-template-example.readthedocs.io/en/latest/
 sonar.links.scm=https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example

{oe_python_template_example-0.1.1 → oe_python_template_example-0.1.4}/src/oe_python_template_example/api.py

@@ -90,22 +90,14 @@ api_v2 = FastAPI(
 
 
 class _HealthStatus(StrEnum):
-    """Health status enumeration.
-
-    Args:
-        StrEnum (_type_): _description_
-    """
+    """Health status enumeration."""
 
     UP = "UP"
     DOWN = "DOWN"
 
 
 class Health(BaseModel):
-    """Health status model.
-
-    Args:
-        BaseModel (_type_): _description_
-    """
+    """Health status model."""
 
     status: _HealthStatus
     reason: str | None = None
@@ -135,10 +127,6 @@ async def health(service: Annotated[Service, Depends(get_service)], response: Re
     The response will have a 200 OK status code if the service is healthy,
     and a 500 Internal Server Error status code if the service is unhealthy.
 
-    Args:
-        service (Annotated[Service, Depends): _description_
-        response (Response): _description_
-
     Returns:
         Health: The health status of the service.
     """
@@ -231,7 +219,7 @@ async def echo_v2(request: Utterance) -> EchoResponse:
     Echo back the provided utterance.
 
     Args:
-        request (EchoRequestV2): The request containing the utterance to echo back.
+        request (Utterance): The request containing the utterance to echo back.
 
     Returns:
         EchoResponse: A response containing the echoed utterance.

{oe_python_template_example-0.1.1 → oe_python_template_example-0.1.4}/uv.lock

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

oe_python_template_example-0.1.1/VERSION

@@ -1 +0,0 @@
-0.1.1

oe_python_template_example-0.1.1/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_example 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
-}