oe-python-template-example 0.2.7__py3-none-any.whl → 0.2.9__py3-none-any.whl

oe_python_template_example/api.py

@@ -15,7 +15,7 @@ from typing import Annotated
 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"])

oe_python_template_example/cli.py

@@ -9,12 +9,24 @@ import uvicorn
 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:

oe_python_template_example/service.py

@@ -1,10 +1,11 @@
-"""Service of OE Python Template Example's."""
+"""Service of OE Python Template Example."""
 
 import os
 
 from dotenv import load_dotenv
 
-from oe_python_template_example.models import Echo, Utterance
+from .models import Echo, Utterance
+from .settings import Language, Settings
 
 load_dotenv()
 THE_VAR = os.getenv("THE_VAR", "not defined")
@@ -13,28 +14,43 @@ THE_VAR = os.getenv("THE_VAR", "not defined")
 class Service:
     """Service of OE Python Template Example."""
 
+    _settings: Settings
+
     def __init__(self) -> None:
         """Initialize service."""
+        self._settings = Settings()  # pyright: ignore[reportCallIssue] - false positive
         self.is_healthy = True
 
-    @staticmethod
-    def get_hello_world() -> str:
+    def healthy(self) -> bool:
         """
-        Get a hello world message.
+        Check if the service is healthy.
 
         Returns:
-            str: Hello world message.
+            bool: True if the service is healthy, False otherwise.
         """
-        return f"Hello, world! The value of THE_VAR is {THE_VAR}"
+        return self.is_healthy
 
-    def healthy(self) -> bool:
+    def info(self) -> str:
         """
-        Check if the service is healthy.
+        Get info about configuration of service.
 
         Returns:
-            bool: True if the service is healthy, False otherwise.
+            str: Service configuration.
         """
-        return self.is_healthy
+        return self._settings.model_dump_json()
+
+    def get_hello_world(self) -> str:
+        """
+        Get a hello world message.
+
+        Returns:
+            str: Hello world message.
+        """
+        match self._settings.language:
+            case Language.GERMAN:
+                return "Hallo, Welt!"
+            case _:
+                return "Hello, world!"
 
     @staticmethod
     def echo(utterance: Utterance) -> Echo:

oe_python_template_example/settings.py

@@ -0,0 +1,35 @@
+"""Settings of OE Python Template Example."""
+
+from enum import StrEnum
+from typing import Annotated
+
+from pydantic import Field
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+from . import __project_name__
+
+
+class Language(StrEnum):
+    """Supported languages."""
+
+    GERMAN = "de_DE"
+    US_ENGLISH = "en_US"
+
+
+class Settings(BaseSettings):
+    """Settings."""
+
+    model_config = SettingsConfigDict(
+        env_prefix=f"{__project_name__.upper()}_",
+        extra="ignore",
+        env_file=".env",
+        env_file_encoding="utf-8",
+    )
+
+    language: Annotated[
+        Language,
+        Field(
+            Language.US_ENGLISH,
+            description="Language to use for output - defaults to US english.",
+        ),
+    ]

{oe_python_template_example-0.2.7.dist-info → oe_python_template_example-0.2.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template-example
-Version: 0.2.7
+Version: 0.2.9
 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/
@@ -48,15 +48,15 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Typing :: Typed
 Requires-Python: <4.0,>=3.11
-Requires-Dist: fastapi[all,standard]>=0.115.11
+Requires-Dist: fastapi[all,standard]>=0.115.12
+Requires-Dist: pydantic-settings>=2.8.1
 Requires-Dist: pydantic>=2.10.6
-Requires-Dist: python-dotenv>=1.0.1
 Requires-Dist: typer>=0.15.1
 Provides-Extra: examples
 Requires-Dist: jinja2>=3.1.6; extra == 'examples'
 Requires-Dist: jupyter>=1.1.1; extra == 'examples'
-Requires-Dist: marimo>=0.11.19; extra == 'examples'
-Requires-Dist: streamlit>=1.43.2; extra == 'examples'
+Requires-Dist: marimo>=0.11.28; extra == 'examples'
+Requires-Dist: streamlit>=1.44.0; extra == 'examples'
 Description-Content-Type: text/markdown
 
 

oe_python_template_example-0.2.9.dist-info/RECORD

@@ -0,0 +1,12 @@
+oe_python_template_example/__init__.py,sha256=Ks3KjkBuzEO1gaezabSfal_WVOsJbuweHwRCs58oRv4,435
+oe_python_template_example/api.py,sha256=_4-Xauw5jA9a6VPTJ5RBjBcbB7gd6Pn585b5OULF13A,5034
+oe_python_template_example/cli.py,sha256=xqIiE2iYkzkGIj9g94ISolGmRd09gxyjbyKhSV1OStM,3761
+oe_python_template_example/constants.py,sha256=6uQHr2CRgzWQWhUQCRRKiPuFhzKB2iblZk3dIRQ5dDc,358
+oe_python_template_example/models.py,sha256=IbegPBFJq0OCAWS70V-ozl6coMd0dC2OsHZY-nIumGs,846
+oe_python_template_example/service.py,sha256=2bxTQH9JeM4ugoQMpTp-pOdANOSZ0HZrQc4JpJzXBqg,1650
+oe_python_template_example/settings.py,sha256=mQu7Bl2EhR6taQLqbaK1s86Ngn3kLVeEoMyhCqbydig,751
+oe_python_template_example-0.2.9.dist-info/METADATA,sha256=Dl2KxhDGOudFls8zMI9AKGk7jLVdiJ8D9wS2II2e_jg,28970
+oe_python_template_example-0.2.9.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+oe_python_template_example-0.2.9.dist-info/entry_points.txt,sha256=S2eCPB45b1Wgj_GsDRFAN-e4h7dBA5UPxT8od98erDE,82
+oe_python_template_example-0.2.9.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
+oe_python_template_example-0.2.9.dist-info/RECORD,,

oe_python_template_example-0.2.7.dist-info/RECORD

@@ -1,11 +0,0 @@
-oe_python_template_example/__init__.py,sha256=Ks3KjkBuzEO1gaezabSfal_WVOsJbuweHwRCs58oRv4,435
-oe_python_template_example/api.py,sha256=Al2SrT0O8NFdb93OFi-5vFtMJ3TKps-pooMZynDU9B8,5010
-oe_python_template_example/cli.py,sha256=a2NXRpybbrCGzlpPDk-YKwxD1TFV0xPdwWgYqGgv0vs,3541
-oe_python_template_example/constants.py,sha256=6uQHr2CRgzWQWhUQCRRKiPuFhzKB2iblZk3dIRQ5dDc,358
-oe_python_template_example/models.py,sha256=IbegPBFJq0OCAWS70V-ozl6coMd0dC2OsHZY-nIumGs,846
-oe_python_template_example/service.py,sha256=Hm3uytzdik2v66agUAX9IsH_tynSuCu4NZK9BySEMUM,1226
-oe_python_template_example-0.2.7.dist-info/METADATA,sha256=WHhQv5kl4DAOgOx7_mDAWhYNbWKQdPbwyLuJBhRvbCM,28966
-oe_python_template_example-0.2.7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-oe_python_template_example-0.2.7.dist-info/entry_points.txt,sha256=S2eCPB45b1Wgj_GsDRFAN-e4h7dBA5UPxT8od98erDE,82
-oe_python_template_example-0.2.7.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
-oe_python_template_example-0.2.7.dist-info/RECORD,,