oe-python-template 0.6.17__tar.gz → 0.6.18__tar.gz

{oe_python_template-0.6.17 → oe_python_template-0.6.18}/.copier-answers.yml

@@ -1,4 +1,4 @@
-_commit: v0.6.16-1-g0e35063
+_commit: v0.6.17-7-g3aa4b83
 _src_path: .
 author_email: helmuthva@gmail.com
 author_github_username: helmut-hoffer-von-ankershoffen

{oe_python_template-0.6.17 → oe_python_template-0.6.18}/CHANGELOG.md

@@ -1,6 +1,22 @@
 [🧠 OE Python Template](https://oe-python-template.readthedocs.io/en/latest/)
 
-## [0.6.17](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.6.16..0.6.17) - 2025-03-18
+## [0.6.18](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.6.17..0.6.18) - 2025-03-18
+
+### 📚 Documentation
+
+- *(api)* Pdf - ([ecd7dda](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/ecd7dda9fedc464976b5b2f8afa56cf0a35c645f))
+
+### ⚙️ Miscellaneous Tasks
+
+- *(rtd)* Debug - ([80703d7](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/80703d734a8cd77e35aad6aec14bdefb9d61ed51))
+- Debug rtd - ([bc760ac](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/bc760aca603950b8dd1cf5c77241b2f8ccc091d2))
+- Debug rtd pdf link - ([192df7f](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/192df7f2552180eb721fd21b32f9e074c0f35073))
+
+## New Contributors ❤️
+
+* @helmut-hoffer-von-ankershoffen made their first contribution
+
+## [0.6.17](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.6.16..v0.6.17) - 2025-03-18
 
 ### ⛰️  Features
 

{oe_python_template-0.6.17 → oe_python_template-0.6.18}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template
-Version: 0.6.17
+Version: 0.6.18
 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.6.18/RELEASE_NOTES.md

@@ -0,0 +1,14 @@
+## [0.6.18](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.6.17..v0.6.18) - 2025-03-18
+
+### 📚 Documentation
+
+- *(api)* Pdf - ([ecd7dda](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/ecd7dda9fedc464976b5b2f8afa56cf0a35c645f))
+
+### ⚙️ Miscellaneous Tasks
+
+- *(rtd)* Debug - ([80703d7](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/80703d734a8cd77e35aad6aec14bdefb9d61ed51))
+- Debug rtd - ([bc760ac](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/bc760aca603950b8dd1cf5c77241b2f8ccc091d2))
+- Debug rtd pdf link - ([192df7f](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/192df7f2552180eb721fd21b32f9e074c0f35073))
+
+
+

oe_python_template-0.6.18/VERSION

@@ -0,0 +1 @@
+0.6.18

oe_python_template-0.6.18/docs/source/_static/openapi_v1.yaml

@@ -0,0 +1,204 @@
+components:
+  schemas:
+    EchoRequest:
+      description: Request model for echo endpoint.
+      properties:
+        text:
+          description: The text to echo back
+          examples:
+          - Hello, world!
+          minLength: 1
+          title: Text
+          type: string
+      required:
+      - text
+      title: EchoRequest
+      type: object
+    EchoResponse:
+      description: Response model for echo endpoint.
+      properties:
+        message:
+          description: The message content
+          examples:
+          - Hello, world!
+          minLength: 1
+          title: Message
+          type: string
+      required:
+      - message
+      title: EchoResponse
+      type: object
+    HTTPValidationError:
+      properties:
+        detail:
+          items:
+            $ref: '#/components/schemas/ValidationError'
+          title: Detail
+          type: array
+      title: HTTPValidationError
+      type: object
+    Health:
+      description: Health status model.
+      properties:
+        reason:
+          anyOf:
+          - type: string
+          - type: 'null'
+          title: Reason
+        status:
+          $ref: '#/components/schemas/_HealthStatus'
+      required:
+      - status
+      title: Health
+      type: object
+    HelloWorldResponse:
+      description: Response model for hello-world endpoint.
+      properties:
+        message:
+          description: The hello world message
+          examples:
+          - Hello, world!
+          title: Message
+          type: string
+      required:
+      - message
+      title: HelloWorldResponse
+      type: object
+    ValidationError:
+      properties:
+        loc:
+          items:
+            anyOf:
+            - type: string
+            - type: integer
+          title: Location
+          type: array
+        msg:
+          title: Message
+          type: string
+        type:
+          title: Error Type
+          type: string
+      required:
+      - loc
+      - msg
+      - type
+      title: ValidationError
+      type: object
+    _HealthStatus:
+      description: Health status enumeration.
+      enum:
+      - UP
+      - DOWN
+      title: _HealthStatus
+      type: string
+info:
+  contact:
+    email: helmuthva@gmail.com
+    name: Helmut Hoffer von Ankershoffen
+    url: https://github.com/helmut-hoffer-von-ankershoffen
+  termsOfService: https://oe-python-template.readthedocs.io/en/latest/
+  title: OE Python Template
+  version: 1.0.0
+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\
+        \ 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':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/EchoResponse'
+          description: Successful Response
+        '422':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      summary: Echo
+      tags:
+      - 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\nReturns:\n   
+Health:\
+        \ The health status of the service."
+      operationId: health_health_get
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Health'
+          description: Successful Response
+      summary: Health
+      tags:
+      - 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\nReturns:\n   
+Health:\
+        \ The health status of the service."
+      operationId: health_healthz_get
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Health'
+          description: Successful Response
+      summary: Health
+      tags:
+      - Observability
+  /hello-world:
+    get:
+      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':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/HelloWorldResponse'
+          description: Successful Response
+      summary: Hello World
+      tags:
+      - Basics

oe_python_template-0.6.18/docs/source/_static/openapi_v2.json

@@ -0,0 +1,62 @@
+Traceback (most recent call last):
+  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/bin/oe-python-template", line 4, in <module>
+    from oe_python_template.cli import cli
+  File "/Users/helmut/Code/oe-python-template/src/oe_python_template/cli.py", line 13, in <module>
+    from oe_python_template.api import api_v1, api_v2
+  File "/Users/helmut/Code/oe-python-template/src/oe_python_template/api.py", line 16, in <module>
+    from fastapi import Depends, FastAPI, Response, status
+  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/lib/python3.13/site-packages/fastapi/__init__.py", line 7, in <module>
+    from .applications import FastAPI as FastAPI
+  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/lib/python3.13/site-packages/fastapi/applications.py", line 16, in <module>
+    from fastapi import routing
+  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/lib/python3.13/site-packages/fastapi/routing.py", line 24, in <module>
+    from fastapi import params
+  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/lib/python3.13/site-packages/fastapi/params.py", line 5, in <module>
+    from fastapi.openapi.models import Example
+  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/lib/python3.13/site-packages/fastapi/openapi/models.py", line 4, in <module>
+    from fastapi._compat import (
+    ...<6 lines>...
+    )
+  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/lib/python3.13/site-packages/fastapi/_compat.py", line 21, in <module>
+    from fastapi.exceptions import RequestErrorModel
+  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/lib/python3.13/site-packages/fastapi/exceptions.py", line 139, in <module>
+    RequestErrorModel: Type[BaseModel] = create_model("Request")
+                                         ~~~~~~~~~~~~^^^^^^^^^^^
+  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/lib/python3.13/site-packages/pydantic/main.py", line 1678, in create_model
+    return meta(
+        model_name,
+    ...<4 lines>...
+        **kwds,
+    )
+  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/lib/python3.13/site-packages/pydantic/_internal/_model_construction.py", line 224, in __new__
+    complete_model_class(
+    ~~~~~~~~~~~~~~~~~~~~^
+        cls,
+        ^^^^
+    ...<4 lines>...
+        create_model_module=_create_model_module,
+        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+    )
+    ^
+  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/lib/python3.13/site-packages/pydantic/_internal/_model_construction.py", line 620, in complete_model_class
+    cls.__pydantic_validator__ = create_schema_validator(
+                                 ~~~~~~~~~~~~~~~~~~~~~~~^
+        schema,
+        ^^^^^^^
+    ...<5 lines>...
+        config_wrapper.plugin_settings,
+        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+    )
+    ^
+  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/lib/python3.13/site-packages/pydantic/plugin/_schema_validator.py", line 38, in create_schema_validator
+    plugins = get_plugins()
+  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/lib/python3.13/site-packages/pydantic/plugin/_loader.py", line 39, in get_plugins
+    for entry_point in dist.entry_points:
+                       ^^^^^^^^^^^^^^^^^
+  File "/opt/homebrew/Cellar/python@3.13/3.13.2/Frameworks/Python.framework/Versions/3.13/lib/python3.13/importlib/metadata/__init__.py", line 496, in entry_points
+    return EntryPoints._from_text_for(self.read_text('entry_points.txt'), self)
+           ~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+  File "/opt/homebrew/Cellar/python@3.13/3.13.2/Frameworks/Python.framework/Versions/3.13/lib/python3.13/importlib/metadata/__init__.py", line 294, in _from_text_for
+    @classmethod
+    
+KeyboardInterrupt

{oe_python_template-0.6.17 → oe_python_template-0.6.18}/docs/source/_static/openapi_v2.yaml

@@ -104,9 +104,12 @@ openapi: 3.1.0
 paths:
   /echo:
     post:
-      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\
+      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:
@@ -133,12 +136,18 @@ paths:
       - 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\nReturns:\n    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.\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:
@@ -153,12 +162,18 @@ paths:
       - 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\nReturns:\n    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.\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:
@@ -173,7 +188,8 @@ paths:
       - 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.6.18/docs/source/api_v1.rst

@@ -0,0 +1,9 @@
+API V1
+======
+
+.. only:: html
+
+    .. swagger-plugin:: _static/openapi_v1.yaml
+        :full-page:
+
+Visit the `Interactive API Documentation <https: //oe-python-template.readthedocs.io/en/latest/api_v1.html>`_

oe_python_template-0.6.18/docs/source/api_v2.rst

@@ -0,0 +1,9 @@
+API V2
+======
+
+.. only:: html
+
+   .. swagger-plugin:: _static/openapi_v2.yaml
+      :full-page:
+
+Visit the `Interactive API Documentation <https://oe-python-template.readthedocs.io/en/latest/api_v2.html>`_

{oe_python_template-0.6.17 → oe_python_template-0.6.18}/docs/source/conf.py

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

{oe_python_template-0.6.17 → oe_python_template-0.6.18}/pyproject.toml

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

{oe_python_template-0.6.17 → oe_python_template-0.6.18}/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.6.17
+sonar.projectVersion=0.6.18
 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.6.18/template/docs/source/api_v1.rst.jinja

@@ -0,0 +1,9 @@
+API V1
+======
+
+.. only:: html
+
+    .. swagger-plugin:: _static/openapi_v1.yaml
+        :full-page:
+
+Visit the `Interactive API Documentation <https: //{{ readthedocs_project_key }}.readthedocs.io/en/latest/api_v1.html>`_

oe_python_template-0.6.18/template/docs/source/api_v2.rst.jinja

@@ -0,0 +1,9 @@
+API V2
+======
+
+.. only:: html
+
+   .. swagger-plugin:: _static/openapi_v2.yaml
+      :full-page:
+
+Visit the `Interactive API Documentation <https://{{ readthedocs_project_key }}.readthedocs.io/en/latest/api_v2.html>`_

{oe_python_template-0.6.17 → oe_python_template-0.6.18}/uv.lock

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

oe_python_template-0.6.17/RELEASE_NOTES.md

@@ -1,8 +0,0 @@
-## [0.6.17](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.6.16..v0.6.17) - 2025-03-18
-
-### ⛰️  Features
-
-- *(docs_pdf)* Check for latex tooling - ([3c35f28](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/3c35f280652557650e4aa40c8b459ed42c536a65))
-
-
-

oe_python_template-0.6.17/VERSION

@@ -1 +0,0 @@
-0.6.17

oe_python_template-0.6.17/docs/source/_static/openapi_v1.yaml

@@ -1,36 +0,0 @@
-Traceback (most recent call last):
-  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/bin/oe-python-template", line 4, in <module>
-    from oe_python_template.cli import cli
-  File "/Users/helmut/Code/oe-python-template/src/oe_python_template/cli.py", line 7, in <module>
-    import typer
-  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/lib/python3.13/site-packages/typer/__init__.py", line 29, in <module>
-    from .main import Typer as Typer
-  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/lib/python3.13/site-packages/typer/main.py", line 21, in <module>
-    from .core import (
-    ...<6 lines>...
-    )
-  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/lib/python3.13/site-packages/typer/core.py", line 36, in <module>
-    from . import rich_utils
-  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/lib/python3.13/site-packages/typer/rich_utils.py", line 14, in <module>
-    from rich.columns import Columns
-  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/lib/python3.13/site-packages/rich/columns.py", line 7, in <module>
-    from .console import Console, ConsoleOptions, RenderableType, RenderResult
-  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/lib/python3.13/site-packages/rich/console.py", line 59, in <module>
-    from .pretty import Pretty, is_expandable
-  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/lib/python3.13/site-packages/rich/pretty.py", line 33, in <module>
-    import attr as _attr_module
-  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/lib/python3.13/site-packages/attr/__init__.py", line 10, in <module>
-    from . import converters, exceptions, filters, setters, validators
-  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/lib/python3.13/site-packages/attr/converters.py", line 10, in <module>
-    from ._make import NOTHING, Converter, Factory, pipe
-  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/lib/python3.13/site-packages/attr/_make.py", line 21, in <module>
-    from . import _compat, _config, setters
-  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/lib/python3.13/site-packages/attr/setters.py", line 8, in <module>
-    from .exceptions import FrozenAttributeError
-  File "<frozen importlib._bootstrap>", line 1360, in _find_and_load
-  File "<frozen importlib._bootstrap>", line 1331, in _find_and_load_unlocked
-  File "<frozen importlib._bootstrap>", line 935, in _load_unlocked
-  File "<frozen importlib._bootstrap_external>", line 1022, in exec_module
-  File "<frozen importlib._bootstrap_external>", line 1118, in get_code
-  File "<frozen importlib._bootstrap_external>", line 1218, in get_data
-KeyboardInterrupt