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

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

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

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

@@ -1,6 +1,13 @@
 [🧠 OE Python Template](https://oe-python-template.readthedocs.io/en/latest/)
 
-## [0.4.4](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.4.3..0.4.4) - 2025-03-13
+## [0.4.5](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.4.4..0.4.5) - 2025-03-13
+
+### 📚 Documentation
+
+- Typo - ([1ffcb14](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/1ffcb14d72f004548be818e418869c3c4fda1dc4))
+
+
+## [0.4.4](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.4.3..v0.4.4) - 2025-03-13
 
 ### 📚 Documentation
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template
-Version: 0.4.4
+Version: 0.4.5
 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/

oe_python_template-0.4.5/RELEASE_NOTES.md

@@ -0,0 +1,8 @@
+## [0.4.5](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.4.4..v0.4.5) - 2025-03-13
+
+### 📚 Documentation
+
+- Typo - ([1ffcb14](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/1ffcb14d72f004548be818e418869c3c4fda1dc4))
+
+
+

oe_python_template-0.4.5/VERSION

@@ -0,0 +1 @@
+0.4.5

{oe_python_template-0.4.4 → oe_python_template-0.4.5}/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-0.4.4 → oe_python_template-0.4.5}/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
@@ -106,12 +104,9 @@ openapi: 3.1.0
 paths:
   /echo:
     post:
-      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\
+      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:
@@ -138,21 +133,13 @@ Unprocessable\
       - Basics
   /health:
     get:
-      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.\n\
-        If 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.\n\
+        If 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':
@@ -166,21 +153,13 @@ _description_\n\
       - Observability
   /healthz:
     get:
-      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.\n\
-        If 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.\n\
+        If 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':
@@ -194,8 +173,7 @@ _description_\n\
       - Observability
   /hello-world:
     get:
-      description: "Return a hello world message.\n\nReturns:\n    
-HelloWorldResponse:\
+      description: "Return a hello world message.\n\nReturns:\n    HelloWorldResponse:\
         \ A response containing the hello world message."
       operationId: hello_world_hello_world_get
       responses:

{oe_python_template-0.4.4 → oe_python_template-0.4.5}/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-0.4.4 → oe_python_template-0.4.5}/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
@@ -106,12 +104,9 @@ openapi: 3.1.0
 paths:
   /echo:
     post:
-      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\
+      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:
@@ -138,21 +133,13 @@ Unprocessable\
       - Basics
   /health:
     get:
-      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.\n\
-        If 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.\n\
+        If 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':
@@ -166,21 +153,13 @@ _description_\n\
       - Observability
   /healthz:
     get:
-      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.\n\
-        If 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.\n\
+        If 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':
@@ -194,8 +173,7 @@ _description_\n\
       - Observability
   /hello-world:
     get:
-      description: "Return a hello world message.\n\nReturns:\n    
-HelloWorldResponse:\
+      description: "Return a hello world message.\n\nReturns:\n    HelloWorldResponse:\
         \ A response containing the hello world message."
       operationId: hello_world_hello_world_get
       responses:

{oe_python_template-0.4.4 → oe_python_template-0.4.5}/docs/source/api_v2.rst

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

{oe_python_template-0.4.4 → oe_python_template-0.4.5}/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.4"
+version = "0.4.5"
 release = version
 github_username = "helmut-hoffer-von-ankershoffen"
 github_repository = "oe-python-template"

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

@@ -1,6 +1,6 @@
 [project]
 name = "oe-python-template"
-version = "0.4.4"
+version = "0.4.5"
 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.4"
+current_version = "0.4.5"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"

{oe_python_template-0.4.4 → oe_python_template-0.4.5}/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.4
+sonar.projectVersion=0.4.5
 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.4 → oe_python_template-0.4.5}/src/oe_python_template/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-0.4.4 → oe_python_template-0.4.5}/template/docs/source/api_v2.rst.jinja

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

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

@@ -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-0.4.4 → oe_python_template-0.4.5}/uv.lock

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

oe_python_template-0.4.4/RELEASE_NOTES.md

@@ -1,8 +0,0 @@
-## [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

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