chore(deps): update from template

Author: helmut-hoffer-von-ankershoffen

.copier-answers.yml

@@ -1,4 +1,4 @@
-_commit: v0.7.4
+_commit: v0.7.6
 _src_path: gh:helmut-hoffer-von-ankershoffen/oe-python-template
 attestations_enabled: true
 author_email: helmuthva@gmail.com

.env.example

@@ -1 +1 @@
-THE_KEY=A value
+OE_PYTHON_TEMPLATE_LANGUAGE=de_DE

CONTRIBUTING.md

@@ -33,8 +33,9 @@ If you are one of the committers of https://github.com/helmut-hoffer-von-ankersh
 src/oe_python_template_example/  # Source code
 ├── __init__.py          # Package initialization
 ├── constants.py         # Constants used throughout the app
-├── service.py           # Service exposed for use as shared library
+├── settings.py          # Settings loaded from environment and .env
 ├── models.py            # Models and data structures
+├── service.py           # Service exposed for use as shared library
 ├── cli.py               # CLI enabling to interact with service from terminal
 └── api.py               # API exposing service as web service
 tests/                   # Unit and E2E tests
@@ -154,7 +155,7 @@ Build and run the Docker image with docker compose:
 
 ```shell
 echo "Building the Docker image with docker compose and running CLI..."
-docker compose run --build oe-python-template --help
+docker compose run --build oe-python-template-example --help
 echo "Building the Docker image with docker compose and running API container as a daemon ..."
 docker compose up --build -d
 echo "Waiting for the API server to start..."

docs/source/_static/openapi_v1.yaml

@@ -1,174 +1,31 @@
-components:
-  schemas:
-    Echo:
-      description: Response model for echo endpoint.
-      properties:
-        text:
-          description: The echo
-          examples:
-          - HELLO, WORLD!
-          minLength: 1
-          title: Text
-          type: string
-      required:
-      - text
-      title: Echo
-      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
-    HealthStatus:
-      description: Health status enumeration.
-      enum:
-      - UP
-      - DOWN
-      title: HealthStatus
-      type: string
-    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
-    _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
-info:
-  contact:
-    email: helmuthva@gmail.com
-    name: Helmut Hoffer von Ankershoffen
-    url: https://github.com/helmut-hoffer-von-ankershoffen
-  termsOfService: https://oe-python-template-example.readthedocs.io/en/latest/
-  title: OE Python Template Example
-  version: 1.0.0
-openapi: 3.1.0
-paths:
-  /echo/{text}:
-    get:
-      description: "Echo back the provided text.\n\nArgs:\n    text (str): The text\
-        \ to echo.\n\nReturns:\n    Echo: The echo.\n\nRaises:\n    422 Unprocessable\
-        \ Entity: If text is not provided or empty."
-      operationId: echo_echo__text__get
-      parameters:
-      - in: path
-        name: text
-        required: true
-        schema:
-          title: Text
-          type: string
-      responses:
-        '200':
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Echo'
-          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
+Traceback (most recent call last):
+  File "/Users/helmut/Code/oe-python-template-example/.nox/docs-3-13/bin/oe-python-template-example", line 4, in <module>
+    from oe_python_template_example.cli import cli
+  File "/Users/helmut/Code/oe-python-template-example/src/oe_python_template_example/__init__.py", line 8, in <module>
+    from .models import Echo, Health, HealthStatus, Utterance
+  File "/Users/helmut/Code/oe-python-template-example/src/oe_python_template_example/models.py", line 5, in <module>
+    from pydantic import BaseModel, Field
+  File "<frozen importlib._bootstrap>", line 1412, in _handle_fromlist
+  File "/Users/helmut/Code/oe-python-template-example/.nox/docs-3-13/lib/python3.13/site-packages/pydantic/__init__.py", line 421, in __getattr__
+    module = import_module(module_name, package=package)
+  File "/opt/homebrew/Cellar/python@3.13/3.13.2/Frameworks/Python.framework/Versions/3.13/lib/python3.13/importlib/__init__.py", line 88, in import_module
+    return _bootstrap._gcd_import(name[level:], package, level)
+           ~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+  File "/Users/helmut/Code/oe-python-template-example/.nox/docs-3-13/lib/python3.13/site-packages/pydantic/main.py", line 34, in <module>
+    from ._internal import (
+    ...<12 lines>...
+    )
+  File "/Users/helmut/Code/oe-python-template-example/.nox/docs-3-13/lib/python3.13/site-packages/pydantic/_internal/_generics.py", line 8, in <module>
+    from contextvars import ContextVar
+  File "/opt/homebrew/Cellar/python@3.13/3.13.2/Frameworks/Python.framework/Versions/3.13/lib/python3.13/contextvars.py", line 1, in <module>
+    from _contextvars import Context, ContextVar, Token, copy_context
+  File "<frozen importlib._bootstrap>", line 1360, in _find_and_load
+  File "<frozen importlib._bootstrap>", line 1322, in _find_and_load_unlocked
+  File "<frozen importlib._bootstrap>", line 1262, in _find_spec
+  File "<frozen importlib._bootstrap_external>", line 1559, in find_spec
+  File "<frozen importlib._bootstrap_external>", line 1533, in _get_spec
+  File "<frozen importlib._bootstrap_external>", line 1666, in find_spec
+  File "<frozen importlib._bootstrap_external>", line 1621, in _get_spec
+  File "<frozen importlib._bootstrap_external>", line 859, in spec_from_file_location
+  File "<frozen importlib._bootstrap_external>", line 190, in _path_abspath
+KeyboardInterrupt

pyproject.toml

@@ -64,7 +64,7 @@ requires-python = ">=3.11, <4.0"
 dependencies = [
     "fastapi[standard,all]>=0.115.12",
     "pydantic>=2.10.6",
-    "python-dotenv>=1.1.0",
+    "pydantic-settings>=2.8.1",
     "typer>=0.15.1",
 ]
 
@@ -118,6 +118,7 @@ dev = [
     "pytest-docker>=3.2.0",
     "pytest-env>=1.1.5",
     "pytest-regressions>=2.7.0",
+    "pytest-subprocess>=1.5.3",
     "pytest-xdist[psutil]>=3.6.1",
     "ruff>=0.10.0",
     "sphinx>=8.2.3",
@@ -137,7 +138,7 @@ dev = [
 
 [tool.uv]
 override-dependencies = [ # https://github.com/astral-sh/uv/issues/4422
-    "rfc3987; sys_platform == 'never'",                 # GPLv3
+    "rfc3987; sys_platform == 'never'", # GPLv3
 ]
 
 
@@ -208,7 +209,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 = "reports/mypy_junit.xml"
 plugins = "pydantic.mypy"
 strict = true

src/oe_python_template_example/api.py

@@ -15,7 +15,7 @@
 from fastapi import Depends, FastAPI, Response, status
 from pydantic import BaseModel, Field
 
-from oe_python_template_example import Echo, Health, HealthStatus, Service, Utterance
+from . import Echo, Health, HealthStatus, Service, Utterance
 
 TITLE = "OE Python Template Example"
 HELLO_WORLD_EXAMPLE = "Hello, world!"
@@ -133,14 +133,14 @@ class _HelloWorldResponse(BaseModel):
 
 @api_v1.get("/hello-world", tags=["Basics"])
 @api_v2.get("/hello-world", tags=["Basics"])
-async def hello_world() -> _HelloWorldResponse:
+async def hello_world(service: Annotated[Service, Depends(get_service)]) -> _HelloWorldResponse:
     """
     Return a hello world message.
 
     Returns:
         _HelloWorldResponse: A response containing the hello world message.
     """
-    return _HelloWorldResponse(message=Service.get_hello_world())
+    return _HelloWorldResponse(message=service.get_hello_world())
 
 
 @api_v1.get("/echo/{text}", tags=["Basics"])

src/oe_python_template_example/cli.py

@@ -9,12 +9,24 @@
 import yaml
 from rich.console import Console
 
-from oe_python_template_example import Service, Utterance, __version__
-from oe_python_template_example.api import api_v1, api_v2
-
-console = Console()
+from . import Service, Utterance, __version__
+from .api import api_v1, api_v2
 
 cli = typer.Typer(name="Command Line Interface of OE Python Template Example")
+_service = Service()
+_console = Console()
+
+
+@cli.command()
+def health() -> None:
+    """Indicate if service is healthy."""
+    _console.print(_service.healthy())
+
+
+@cli.command()
+def info() -> None:
+    """Print info about service configuration."""
+    _console.print(_service.info())
 
 
 @cli.command()
@@ -32,15 +44,15 @@ def echo(
     """Echo the text."""
     echo = Service.echo(Utterance(text=text))
     if json:
-        console.print_json(data={"text": echo.text})
+        _console.print_json(data={"text": echo.text})
     else:
-        console.print(echo.text)
+        _console.print(echo.text)
 
 
 @cli.command()
 def hello_world() -> None:
     """Print hello world message and what's in the environment variable THE_VAR."""
-    console.print(Service.get_hello_world())
+    _console.print(_service.get_hello_world())
 
 
 @cli.command()
@@ -50,7 +62,7 @@ def serve(
     watch: Annotated[bool, typer.Option(help="Enable auto-reload")] = True,
 ) -> None:
     """Start the API server."""
-    console.print(f"Starting API server at http://{host}:{port}")
+    _console.print(f"Starting API server at http://{host}:{port}")
     os.environ["UVICORN_HOST"] = host
     os.environ["UVICORN_PORT"] = str(port)
     uvicorn.run(
@@ -111,9 +123,9 @@ def openapi(
             schema = api_v2.openapi()
     match output_format:
         case OutputFormat.JSON:
-            console.print_json(data=schema)
+            _console.print_json(data=schema)
         case OutputFormat.YAML:
-            console.print(yaml.dump(schema, default_flow_style=False), end="")
+            _console.print(yaml.dump(schema, default_flow_style=False), end="")
 
 
 def _apply_cli_settings(cli: typer.Typer, epilog: str) -> None: