oe-python-template 0.6.30__tar.gz → 0.6.32__tar.gz

{oe_python_template-0.6.30 → oe_python_template-0.6.32}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template
-Version: 0.6.30
+Version: 0.6.32
 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/
@@ -112,7 +112,7 @@ This [Copier](https://copier.readthedocs.io/en/stable/) template enables you to
 
 ### Development Infrastructure
 
-Projects generated with the template come with a comprehensive development toolchain and quality assurance framework that supports the entire software development lifecycle - from coding and testing to documentation, release management, and compliance auditing. This infrastructure automates routine tasks, enforces code quality standards, and streamlines the path to production:
+Projects generated with this template come with a comprehensive development toolchain and quality assurance framework that supports the entire software development lifecycle - from coding and testing to documentation, release management, and compliance auditing. This infrastructure automates routine tasks, enforces code quality standards, and streamlines the path to production:
 
 1. Linting with [Ruff](https://github.com/astral-sh/ruff)
 2. Static type checking with [mypy](https://mypy.readthedocs.io/en/stable/)
@@ -198,9 +198,10 @@ external services such as CloudCov, SonarQube Cloud, Read The Docs, Docker.io, a
 ./n bump
 ```
 Notes:
-1. You can remove this section post having successfully generated your project.
-2. The following sections refer to the dummy application and service provided by this template.
-   Use them as inspiration and adapt them to your own project.
+1. You can remove the above sections - from "Scaffolding" to this notes - post having successfully generated your project.
+2. The following sections refer to the dummy application and service generated into the `tests` and `src` folder by this template.
+   Use the documentation and code as inspiration, adapt to your business logic, or remove and start documenting and coding from scratch.
+
 
 ## Overview
 

{oe_python_template-0.6.30 → oe_python_template-0.6.32}/README.md

@@ -51,7 +51,7 @@ This [Copier](https://copier.readthedocs.io/en/stable/) template enables you to
 
 ### Development Infrastructure
 
-Projects generated with the template come with a comprehensive development toolchain and quality assurance framework that supports the entire software development lifecycle - from coding and testing to documentation, release management, and compliance auditing. This infrastructure automates routine tasks, enforces code quality standards, and streamlines the path to production:
+Projects generated with this template come with a comprehensive development toolchain and quality assurance framework that supports the entire software development lifecycle - from coding and testing to documentation, release management, and compliance auditing. This infrastructure automates routine tasks, enforces code quality standards, and streamlines the path to production:
 
 1. Linting with [Ruff](https://github.com/astral-sh/ruff)
 2. Static type checking with [mypy](https://mypy.readthedocs.io/en/stable/)
@@ -137,9 +137,10 @@ external services such as CloudCov, SonarQube Cloud, Read The Docs, Docker.io, a
 ./n bump
 ```
 Notes:
-1. You can remove this section post having successfully generated your project.
-2. The following sections refer to the dummy application and service provided by this template.
-   Use them as inspiration and adapt them to your own project.
+1. You can remove the above sections - from "Scaffolding" to this notes - post having successfully generated your project.
+2. The following sections refer to the dummy application and service generated into the `tests` and `src` folder by this template.
+   Use the documentation and code as inspiration, adapt to your business logic, or remove and start documenting and coding from scratch.
+
 
 ## Overview
 

{oe_python_template-0.6.30 → oe_python_template-0.6.32}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "oe-python-template"
-version = "0.6.30"
+version = "0.6.32"
 description = "🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling."
 readme = "README.md"
 authors = [
@@ -125,7 +125,7 @@ dev = [
     "sphinx-copybutton>=0.5.2",
     "sphinx-inline-tabs>=2023.4.21",
     "sphinx-mdinclude>=0.6.2",
-    "sphinx-pydantic>=0.1.1",
+#    "sphinx-pydantic>=0.1.1",
     "sphinx-rtd-theme>=3.0.2",
     "sphinx_selective_exclude>=1.0.3",
     "sphinx-toolbox>=3.9.0",
@@ -136,6 +136,13 @@ dev = [
     "watchdog>=6.0.0",
 ]
 
+[tool.uv]
+override-dependencies = [ # https://github.com/astral-sh/uv/issues/4422
+    "rfc3987; sys_platform == 'never'",                 # GPLv3
+    "sphinx-jsonschema; sys_platform == 'never'",       # GPLv3
+]
+
+
 [tool.ruff]
 target-version = "py311"
 preview = true
@@ -248,7 +255,7 @@ source = ["src/"]
 
 
 [tool.bumpversion]
-current_version = "0.6.30"
+current_version = "0.6.32"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"

{oe_python_template-0.6.30 → oe_python_template-0.6.32}/src/oe_python_template/__init__.py

@@ -5,10 +5,15 @@ from .constants import (
     __project_path__,
     __version__,
 )
+from .models import Echo, Health, HealthStatus, Utterance
 from .service import Service
 
 __all__ = [
+    "Echo",
+    "Health",
+    "HealthStatus",
     "Service",
+    "Utterance",
     "__project_name__",
     "__project_path__",
     "__version__",

{oe_python_template-0.6.30 → oe_python_template-0.6.32}/src/oe_python_template/api.py

@@ -10,13 +10,12 @@ The endpoints use Pydantic models for request and response validation.
 
 import os
 from collections.abc import Generator
-from enum import StrEnum
 from typing import Annotated
 
 from fastapi import Depends, FastAPI, Response, status
 from pydantic import BaseModel, Field
 
-from oe_python_template import Service
+from oe_python_template import Echo, Health, HealthStatus, Service, Utterance
 
 TITLE = "OE Python Template"
 HELLO_WORLD_EXAMPLE = "Hello, world!"
@@ -94,30 +93,6 @@ api_v2 = FastAPI(
 )
 
 
-class _HealthStatus(StrEnum):
-    """Health status enumeration."""
-
-    UP = "UP"
-    DOWN = "DOWN"
-
-
-class Health(BaseModel):
-    """Health status model."""
-
-    status: _HealthStatus
-    reason: str | None = None
-
-
-class HealthResponse(BaseModel):
-    """Response model for health endpoint."""
-
-    health: str = Field(
-        ...,
-        description="The hello world message",
-        examples=[HELLO_WORLD_EXAMPLE],
-    )
-
-
 @api_v1.get("/healthz", tags=["Observability"])
 @api_v1.get("/health", tags=["Observability"])
 @api_v2.get("/healthz", tags=["Observability"])
@@ -136,17 +111,17 @@ async def health(service: Annotated[Service, Depends(get_service)], response: Re
         Health: The health status of the service.
     """
     if service.healthy():
-        health_result = Health(status=_HealthStatus.UP)
+        health_result = Health(status=HealthStatus.UP)
     else:
-        health_result = Health(status=_HealthStatus.DOWN, reason="Service is unhealthy")
+        health_result = Health(status=HealthStatus.DOWN, reason="Service is unhealthy")
 
-    if health_result.status == _HealthStatus.DOWN:
+    if health_result.status == HealthStatus.DOWN:
         response.status_code = status.HTTP_500_INTERNAL_SERVER_ERROR
 
     return health_result
 
 
-class HelloWorldResponse(BaseModel):
+class _HelloWorldResponse(BaseModel):
     """Response model for hello-world endpoint."""
 
     message: str = Field(
@@ -158,81 +133,48 @@ 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() -> _HelloWorldResponse:
     """
     Return a hello world message.
 
     Returns:
-        HelloWorldResponse: A response containing the hello world message.
+        _HelloWorldResponse: A response containing the hello world message.
     """
-    return HelloWorldResponse(message=Service.get_hello_world())
-
-
-class EchoResponse(BaseModel):
-    """Response model for echo endpoint."""
-
-    message: str = Field(
-        ...,
-        min_length=1,
-        description="The message content",
-        examples=[HELLO_WORLD_EXAMPLE],
-    )
-
-
-class EchoRequest(BaseModel):
-    """Request model for echo endpoint."""
-
-    text: str = Field(
-        ...,
-        min_length=1,
-        description="The text to echo back",
-        examples=[HELLO_WORLD_EXAMPLE],
-    )
+    return _HelloWorldResponse(message=Service.get_hello_world())
 
 
-@api_v1.post("/echo", tags=["Basics"])
-async def echo(request: EchoRequest) -> EchoResponse:
+@api_v1.get("/echo/{text}", tags=["Basics"])
+async def echo(text: str) -> Echo:
     """
     Echo back the provided text.
 
     Args:
-        request (EchoRequest): The request containing the text to echo back.
+        text (str): The text to echo.
 
     Returns:
-        EchoResponse: A response containing the echoed text.
+        Echo: The echo.
 
     Raises:
         422 Unprocessable Entity: If text is not provided or empty.
     """
-    return EchoResponse(message=request.text)
-
-
-class Utterance(BaseModel):
-    """Request model for echo endpoint."""
-
-    utterance: str = Field(
-        ...,
-        min_length=1,
-        description="The utterance to echo back",
-        examples=[HELLO_WORLD_EXAMPLE],
-    )
+    return Service.echo(Utterance(text=text))
 
 
 @api_v2.post("/echo", tags=["Basics"])
-async def echo_v2(request: Utterance) -> EchoResponse:
+async def echo_v2(request: Utterance) -> Echo:
     """
     Echo back the provided utterance.
 
     Args:
-        request (Utterance): The request containing the utterance to echo back.
+        request (Utterance): The utterance to echo back.
 
     Returns:
-        EchoResponse: A response containing the echoed utterance.
+        Echo: The echo.
 
     Raises:
         422 Unprocessable Entity: If utterance is not provided or empty.
     """
-    return EchoResponse(message=request.utterance)
+    return Service.echo(request)
 
 
 api.mount("/v1", api_v1)

{oe_python_template-0.6.30 → oe_python_template-0.6.32}/src/oe_python_template/cli.py

@@ -9,7 +9,7 @@ import uvicorn
 import yaml
 from rich.console import Console
 
-from oe_python_template import Service, __version__
+from oe_python_template import Service, Utterance, __version__
 from oe_python_template.api import api_v1, api_v2
 
 console = Console()
@@ -30,10 +30,11 @@ def echo(
     ] = False,
 ) -> None:
     """Echo the text."""
+    echo = Service.echo(Utterance(text=text))
     if json:
-        console.print_json(data={"text": text})
+        console.print_json(data={"text": echo.text})
     else:
-        console.print(text)
+        console.print(echo.text)
 
 
 @cli.command()

oe_python_template-0.6.32/src/oe_python_template/models.py

@@ -0,0 +1,44 @@
+"""Models used throughout OE Python Template's codebase ."""
+
+from enum import StrEnum
+
+from pydantic import BaseModel, Field
+
+UTTERANCE_EXAMPLE = "Hello, world!"
+ECHO_EXAMPLE = "HELLO, WORLD!"
+
+
+class Utterance(BaseModel):
+    """Model representing a text utterance."""
+
+    text: str = Field(
+        ...,
+        min_length=1,
+        description="The utterance to echo back",
+        examples=[UTTERANCE_EXAMPLE],
+    )
+
+
+class Echo(BaseModel):
+    """Response model for echo endpoint."""
+
+    text: str = Field(
+        ...,
+        min_length=1,
+        description="The echo",
+        examples=[ECHO_EXAMPLE],
+    )
+
+
+class HealthStatus(StrEnum):
+    """Health status enumeration."""
+
+    UP = "UP"
+    DOWN = "DOWN"
+
+
+class Health(BaseModel):
+    """Health status model."""
+
+    status: HealthStatus
+    reason: str | None = None

{oe_python_template-0.6.30 → oe_python_template-0.6.32}/src/oe_python_template/service.py

@@ -1,9 +1,11 @@
-"""Service of OE Python Template."""
+"""Service of OE Python Template's."""
 
 import os
 
 from dotenv import load_dotenv
 
+from oe_python_template.models import Echo, Utterance
+
 load_dotenv()
 THE_VAR = os.getenv("THE_VAR", "not defined")
 
@@ -33,3 +35,19 @@ class Service:
             bool: True if the service is healthy, False otherwise.
         """
         return self.is_healthy
+
+    @staticmethod
+    def echo(utterance: Utterance) -> Echo:
+        """
+        Loudly echo utterance.
+
+        Args:
+            utterance (Utterance): The utterance to echo.
+
+        Returns:
+            Echo: The loudly echoed utterance.
+
+        Raises:
+            ValueError: If the utterance is empty or contains only whitespace.
+        """
+        return Echo(text=utterance.text.upper())