oe-python-template 0.7.4__tar.gz → 0.7.6__tar.gz

{oe_python_template-0.7.4 → oe_python_template-0.7.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template
-Version: 0.7.4
+Version: 0.7.6
 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/
@@ -49,8 +49,8 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Typing :: Typed
 Requires-Python: <4.0,>=3.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.1.0
 Requires-Dist: typer>=0.15.1
 Provides-Extra: examples
 Requires-Dist: jinja2>=3.1.6; extra == 'examples'

{oe_python_template-0.7.4 → oe_python_template-0.7.6}/pyproject.toml

@@ -1,11 +1,9 @@
 [project]
 name = "oe-python-template"
-version = "0.7.4"
+version = "0.7.6"
 description = "🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling."
 readme = "README.md"
-authors = [
-    { name = "Helmut Hoffer von Ankershoffen", email = "helmuthva@gmail.com" },
-]
+authors = [{ name = "Helmut Hoffer von Ankershoffen", email = "helmuthva@gmail.com" }]
 license = { file = "LICENSE" }
 
 keywords = [
@@ -64,7 +62,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 +116,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 +136,7 @@ dev = [
 
 [tool.uv]
 override-dependencies = [ # https://github.com/astral-sh/uv/issues/4422
-    "rfc3987; sys_platform == 'never'",                 # GPLv3
+    "rfc3987; sys_platform == 'never'", # GPLv3
 ]
 
 
@@ -199,7 +198,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]
@@ -208,7 +207,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
@@ -221,7 +220,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
@@ -253,7 +252,7 @@ source = ["src/"]
 
 
 [tool.bumpversion]
-current_version = "0.7.4"
+current_version = "0.7.6"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"

{oe_python_template-0.7.4 → oe_python_template-0.7.6}/src/oe_python_template/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 import Echo, Health, HealthStatus, Service, Utterance
+from . import Echo, Health, HealthStatus, Service, Utterance
 
 TITLE = "OE Python Template"
 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-0.7.4 → oe_python_template-0.7.6}/src/oe_python_template/cli.py

@@ -9,12 +9,24 @@ import uvicorn
 import yaml
 from rich.console import Console
 
-from oe_python_template import Service, Utterance, __version__
-from oe_python_template.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")
+_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-0.7.4 → oe_python_template-0.7.6}/src/oe_python_template/service.py

@@ -1,10 +1,11 @@
-"""Service of OE Python Template's."""
+"""Service of OE Python Template."""
 
 import os
 
 from dotenv import load_dotenv
 
-from oe_python_template.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."""
 
+    _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-0.7.6/src/oe_python_template/settings.py

@@ -0,0 +1,35 @@
+"""Settings of OE Python Template."""
+
+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.",
+        ),
+    ]