oe-python-template-example 0.3.5__py3-none-any.whl → 0.3.7__py3-none-any.whl

oe_python_template_example/utils/_sentry.py

@@ -0,0 +1,97 @@
+"""Sentry integration for application monitoring."""
+
+from typing import Annotated
+
+import sentry_sdk
+from pydantic import Field, PlainSerializer, SecretStr
+from pydantic_settings import SettingsConfigDict
+from sentry_sdk.integrations.typer import TyperIntegration
+
+from ._constants import __env__, __env_file__, __project_name__, __version__
+from ._settings import OpaqueSettings, load_settings
+
+
+class SentrySettings(OpaqueSettings):
+    """Configuration settings for Sentry integration."""
+
+    model_config = SettingsConfigDict(
+        env_prefix=f"{__project_name__.upper()}_SENTRY_",
+        env_file=__env_file__,
+        env_file_encoding="utf-8",
+        extra="ignore",
+    )
+
+    dsn: Annotated[
+        SecretStr | None,
+        PlainSerializer(func=OpaqueSettings.serialize_sensitive_info, return_type=str, when_used="always"),
+        Field(description="Sentry DSN", examples=["https://SECRET@SECRET.ingest.de.sentry.io/SECRET"], default=None),
+    ]
+
+    debug: Annotated[
+        bool,
+        Field(description="Debug (https://docs.sentry.io/platforms/python/configuration/options/)", default=False),
+    ]
+
+    send_default_pii: Annotated[
+        bool,
+        Field(
+            description="Send default personal identifiable information (https://docs.sentry.io/platforms/python/configuration/options/)",
+            default=False,
+        ),
+    ]
+
+    max_breadcrumbs: Annotated[
+        int,
+        Field(
+            description="Max breadcrumbs (https://docs.sentry.io/platforms/python/configuration/options/#max_breadcrumbs)",
+            default=5.0,
+        ),
+    ]
+    sample_rate: Annotated[
+        float,
+        Field(
+            description="Sample Rate (https://docs.sentry.io/platforms/python/configuration/sampling/#sampling-error-events)",
+            default=1.0,
+        ),
+    ]
+    traces_sample_rate: Annotated[
+        float,
+        Field(
+            description="Traces Sample Rate (https://docs.sentry.io/platforms/python/configuration/sampling/#configuring-the-transaction-sample-rate)",
+            default=1.0,
+        ),
+    ]
+    profiles_sample_rate: Annotated[
+        float,
+        Field(
+            description="Traces Sample Rate (https://docs.sentry.io/platforms/python/tracing/#configure)",
+            default=1.0,
+        ),
+    ]
+
+
+def sentry_initialize() -> bool:
+    """Initialize Sentry integration.
+
+    Returns:
+        bool: True if initialized successfully, False otherwise
+    """
+    settings = load_settings(SentrySettings)
+
+    if settings.dsn is None:
+        return False
+
+    sentry_sdk.init(
+        release=f"{__project_name__}@{__version__}",  # https://docs.sentry.io/platforms/python/configuration/releases/,
+        environment=__env__,
+        dsn=settings.dsn.get_secret_value(),
+        max_breadcrumbs=settings.max_breadcrumbs,
+        debug=settings.debug,
+        send_default_pii=settings.send_default_pii,
+        sample_rate=settings.sample_rate,
+        traces_sample_rate=settings.traces_sample_rate,
+        profiles_sample_rate=settings.profiles_sample_rate,
+        integrations=[TyperIntegration()],
+    )
+
+    return True

oe_python_template_example/utils/_service.py

@@ -0,0 +1,39 @@
+"""Base class for services."""
+
+from abc import ABC, abstractmethod
+from typing import Any, TypeVar
+
+from pydantic_settings import BaseSettings
+
+from ._health import Health
+from ._settings import load_settings
+
+T = TypeVar("T", bound=BaseSettings)
+
+
+class BaseService(ABC):
+    """Base class for services."""
+
+    _settings: BaseSettings
+
+    def __init__(self, settings_class: type[T] | None = None) -> None:
+        """
+        Initialize service with optional settings.
+
+        Args:
+            settings_class: Optional settings class to load configuration.
+        """
+        if settings_class is not None:
+            self._settings = load_settings(settings_class)
+
+    def key(self) -> str:
+        """Return the module name of the instance."""
+        return self.__module__.split(".")[-2]
+
+    @abstractmethod
+    def health(self) -> Health:
+        """Get health of this service. Override in subclass."""
+
+    @abstractmethod
+    def info(self) -> dict[str, Any]:
+        """Get info of this service. Override in subclass."""

oe_python_template_example/utils/_settings.py

@@ -0,0 +1,80 @@
+"""Utilities around Pydantic settings."""
+
+import json
+import logging
+import sys
+from pathlib import Path
+from typing import TypeVar
+
+from pydantic import FieldSerializationInfo, SecretStr, ValidationError
+from pydantic_settings import BaseSettings
+from rich.panel import Panel
+from rich.text import Text
+
+from ._console import console
+
+T = TypeVar("T", bound=BaseSettings)
+
+logger = logging.getLogger(__name__)
+
+UNHIDE_SENSITIVE_INFO = "unhide_sensitive_info"
+
+
+class OpaqueSettings(BaseSettings):
+    @staticmethod
+    def serialize_sensitive_info(input_value: SecretStr, info: FieldSerializationInfo) -> str | None:
+        if not input_value:
+            return None
+        if info.context.get(UNHIDE_SENSITIVE_INFO, False):  # type: ignore
+            return input_value.get_secret_value()
+        return str(input_value)
+
+
+def load_settings(settings_class: type[T]) -> T:
+    """
+    Load settings with error handling and nice formatting.
+
+    Args:
+        settings_class: The Pydantic settings class to instantiate
+
+    Returns:
+        (T): Instance of the settings class
+
+    Raises:
+        SystemExit: If settings validation fails
+    """
+    try:
+        return settings_class()
+    except ValidationError as e:
+        errors = json.loads(e.json())
+        text = Text()
+        text.append(
+            "Validation error(s): \n\n",
+            style="debug",
+        )
+
+        prefix = settings_class.model_config.get("env_prefix", "")
+        for error in errors:
+            env_var = f"{prefix}{error['loc'][0]}".upper()
+            logger.fatal(f"Configuration invalid! {env_var}: {error['msg']}")
+            text.append(f"• {env_var}", style="yellow bold")
+            text.append(f": {error['msg']}\n")
+
+        text.append(
+            "\nCheck settings defined in the process environment and in file ",
+            style="info",
+        )
+        env_file = str(settings_class.model_config.get("env_file", ".env") or ".env")
+        text.append(
+            str(Path(__file__).parent.parent.parent.parent / env_file),
+            style="bold blue underline",
+        )
+
+        console.print(
+            Panel(
+                text,
+                title="Configuration invalid!",
+                border_style="error",
+            ),
+        )
+        sys.exit(78)

oe_python_template_example/utils/boot.py

@@ -0,0 +1,86 @@
+"""Boot sequence."""
+
+import os
+import sys
+
+from ._log import logging_initialize
+from ._logfire import logfire_initialize
+from ._sentry import sentry_initialize
+
+_boot_called = False
+
+
+def boot(modules_to_instrument: list[str]) -> None:
+    """Boot the application.
+
+    Args:
+        modules_to_instrument (list): List of modules to be instrumented.
+        repository_url (str): URL of the repository.
+        repository_root_path (str): The root path of the repository. Default is the root path.
+    """
+    global _boot_called  # noqa: PLW0603
+    if _boot_called:
+        return
+    _boot_called = True
+    sentry_initialize()
+    log_to_logfire = logfire_initialize(modules_to_instrument)
+    logging_initialize(log_to_logfire)
+    _amend_library_path()
+    _parse_env_args()
+    _log_boot_message()
+
+
+from ._constants import __project_name__, __version__  # noqa: E402
+from ._log import get_logger  # noqa: E402
+from ._process import get_process_info  # noqa: E402
+
+
+def _parse_env_args() -> None:
+    """Parse --env arguments from command line and add to environment if prefix matches.
+
+    - Last but not least removes those args so typer does not complain about them.
+    """
+    i = 1  # Start after script name
+    to_remove = []
+    prefix = f"{__project_name__.upper()}_"
+
+    while i < len(sys.argv):
+        current_arg = sys.argv[i]
+
+        # Handle "--env KEY=VALUE" or "-e KEY=VALUE" format (two separate arguments)
+        if (current_arg in {"--env", "-e"}) and i + 1 < len(sys.argv):
+            key_value = sys.argv[i + 1]
+            if "=" in key_value:
+                key, value = key_value.split("=", 1)
+                if key.startswith(prefix):
+                    os.environ[key] = value.strip("\"'")
+                to_remove.extend([i, i + 1])
+                i += 2
+                continue
+
+        i += 1
+
+    # Remove processed arguments from sys.argv in reverse order
+    for index in sorted(to_remove, reverse=True):
+        del sys.argv[index]
+
+
+def _amend_library_path() -> None:
+    """Patch environment variables before any other imports."""
+    if "DYLD_FALLBACK_LIBRARY_PATH" not in os.environ:
+        os.environ["DYLD_FALLBACK_LIBRARY_PATH"] = f"{os.getenv('HOMEBREW_PREFIX', '/opt/homebrew')}/lib/"
+
+
+def _log_boot_message() -> None:
+    """Log boot message with version and process information."""
+    logger = get_logger(__name__)
+    process_info = get_process_info()
+    logger.info(
+        "⭐ Booting %s v%s (project root %s, pid %s), parent '%s' (pid %s)",
+        __project_name__,
+        __version__,
+        process_info.project_root,
+        process_info.pid,
+        process_info.parent.name,
+        process_info.parent.pid,
+    )

{oe_python_template_example-0.3.5.dist-info → oe_python_template_example-0.3.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template-example
-Version: 0.3.5
+Version: 0.3.7
 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/
@@ -49,13 +49,25 @@ 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: logfire[system-metrics]>=3.13.1
+Requires-Dist: opentelemetry-instrumentation-fastapi>=0.53b0
+Requires-Dist: opentelemetry-instrumentation-httpx>=0.53b0
+Requires-Dist: opentelemetry-instrumentation-jinja2>=0.53b0
+Requires-Dist: opentelemetry-instrumentation-requests>=0.53b0
+Requires-Dist: opentelemetry-instrumentation-sqlite3>=0.53b0
+Requires-Dist: opentelemetry-instrumentation-tornado>=0.53b0
+Requires-Dist: opentelemetry-instrumentation-urllib3>=0.53b0
+Requires-Dist: opentelemetry-instrumentation-urllib>=0.53b0
+Requires-Dist: psutil>=7.0.0
 Requires-Dist: pydantic-settings>=2.8.1
-Requires-Dist: pydantic>=2.11.1
+Requires-Dist: pydantic>=2.11.3
+Requires-Dist: sentry-sdk>=2.25.1
 Requires-Dist: typer>=0.15.1
+Requires-Dist: uptime>=3.0.1
 Provides-Extra: examples
 Requires-Dist: jinja2>=3.1.6; extra == 'examples'
 Requires-Dist: jupyter>=1.1.1; extra == 'examples'
-Requires-Dist: marimo>=0.12.2; extra == 'examples'
+Requires-Dist: marimo>=0.12.8; extra == 'examples'
 Requires-Dist: streamlit>=1.44.1; extra == 'examples'
 Description-Content-Type: text/markdown
 
@@ -89,6 +101,8 @@ Description-Content-Type: text/markdown
 [![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-orange.json)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template)
 [![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCI+PHBhdGggZmlsbD0iI2ZmZiIgZD0iTTE3IDE2VjdsLTYgNU0yIDlWOGwxLTFoMWw0IDMgOC04aDFsNCAyIDEgMXYxNGwtMSAxLTQgMmgtMWwtOC04LTQgM0gzbC0xLTF2LTFsMy0zIi8+PC9zdmc+)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example)
 [![Open in GitHub Codespaces](https://img.shields.io/static/v1?label=GitHub%20Codespaces&message=Open&color=blue&logo=github)](https://github.com/codespaces/new/helmut-hoffer-von-ankershoffen/oe-python-template-example)
+[![Vercel Deploy](https://deploy-badge.vercel.app/vercel/oe-python-template-example?root=api%2Fv1%2Fhealthz)](https://oe-python-template-example.vercel.app/api/v1/hello/world)
+[![Better Stack Badge](https://uptime.betterstack.com/status-badges/v1/monitor/1vzoq.svg)](https://helmut-hoffer-von-ankershoffen.betteruptime.com/)
 
 <!---
 [![ghcr.io - Version](https://ghcr-badge.egpl.dev/helmut-hoffer-von-ankershoffen/oe-python-template-example/tags?color=%2344cc11&ignore=0.0%2C0%2Clatest&n=3&label=ghcr.io&trim=)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/pkgs/container/oe-python-template-example)
@@ -127,33 +141,40 @@ Projects generated with this template come with a comprehensive development tool
 8. CI/CD pipeline can be run locally with [act](https://github.com/nektos/act)
 9. Code quality and security checks with [SonarQube](https://www.sonarsource.com/products/sonarcloud) and [GitHub CodeQL](https://codeql.github.com/)
 10. Dependency monitoring and vulnerability scanning with [pip-audit](https://pypi.org/project/pip-audit/), [trivy](https://trivy.dev/latest/), [Renovate](https://github.com/renovatebot/renovate), and [GitHub Dependabot](https://docs.github.com/en/code-security/getting-started/dependabot-quickstart-guide)
-11. Licenses of dependencies extracted with [pip-licenses](https://pypi.org/project/pip-licenses/), matched with allow list, and published as release artifacts in CSV and JSON format for further compliance checks
-12. Generation of attributions from extracted licenses
-13. Software Bill of Materials (SBOM) generated in [CycloneDX](https://cyclonedx.org/) and [SPDX](https://spdx.dev/) formats with [cyclonedx-python](https://github.com/CycloneDX/cyclonedx-python) resp. [trivy](https://trivy.dev/latest/), published as release artifacts
-14. Version and release management with [bump-my-version](https://callowayproject.github.io/bump-my-version/)
-15. Changelog and release notes generated with [git-cliff](https://git-cliff.org/)
-16. Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation for the library, CLI, and API
-17. Documentation published to [Read The Docs](https://readthedocs.org/) including generation of PDF and single page HTML versions
-18. Interactive OpenAPI specification with [Swagger](https://swagger.io/)
-19. Python package published to [PyPI](https://pypi.org/)
-20. Docker images published to [Docker.io](https://hub.docker.com/) and [GitHub Container Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry) with [artifact attestations](https://docs.github.com/en/actions/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-to-establish-provenance-for-builds)
-21. One-click development environments with [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) and [GitHub Codespaces](https://github.com/features/codespaces)
-22. Settings for use with [VSCode](https://code.visualstudio.com/)
-23. Settings and custom instructions for use with [GitHub Copilot](https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
+11. Error monitoring and profiling with [Sentry](https://sentry.io/)  (optional)
+12. Logging and metrics with [Logfire](https://logfire.dev/) (optional)
+13. Prepared for uptime monitoring with [betterstack](https://betterstack.com/) or alternatives
+13. Licenses of dependencies extracted with [pip-licenses](https://pypi.org/project/pip-licenses/), matched with allow list, and published as release artifacts in CSV and JSON format for further compliance checks
+14. Generation of attributions from extracted licenses
+15. Software Bill of Materials (SBOM) generated in [CycloneDX](https://cyclonedx.org/) and [SPDX](https://spdx.dev/) formats with [cyclonedx-python](https://github.com/CycloneDX/cyclonedx-python) resp. [trivy](https://trivy.dev/latest/), published as release artifacts
+16. Version and release management with [bump-my-version](https://callowayproject.github.io/bump-my-version/)
+17. Changelog and release notes generated with [git-cliff](https://git-cliff.org/)
+18. Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation for the library, CLI, and API
+19. Documentation published to [Read The Docs](https://readthedocs.org/) including generation of PDF and single page HTML versions
+20. Interactive OpenAPI specification with [Swagger](https://swagger.io/)
+21. Python package published to [PyPI](https://pypi.org/)
+22. Docker images published to [Docker.io](https://hub.docker.com/) and [GitHub Container Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry) with [artifact attestations](https://docs.github.com/en/actions/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-to-establish-provenance-for-builds)
+23. One-click development environments with [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) and [GitHub Codespaces](https://github.com/features/codespaces)
+24. Settings for use with [VSCode](https://code.visualstudio.com/)
+25. Settings and custom instructions for use with [GitHub Copilot](https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
+26. API deployed as serverless function to [Vercel](https://vercel.com/) (optional)
 
 ### Application Features
 
-Beyond development tooling, projects generated with this template include the code, documentation, and configuration of a fully functioning demo application and service. This reference implementation serves as a starting point for your own business logic with modern patterns and practices already in place:
-
-1. Service architecture suitable for use as shared library
-2. Validation with [pydantic](https://docs.pydantic.dev/)
-3. Command-line interface (CLI) with [Typer](https://typer.tiangolo.com/)
-4. Versioned Web API with [FastAPI](https://fastapi.tiangolo.com/)
-5. [Interactive Jupyter notebook](https://jupyter.org/) and [reactive Marimo notebook](https://marimo.io/)
-6. Simple Web UI with [Streamlit](https://streamlit.io/)
-7. Configuration to run the CLI and API in a Docker container including setup for [Docker Compose](https://docs.docker.com/get-started/docker-concepts/the-basics/what-is-docker-compose/)
-8. Documentation including badges, setup instructions, contribution guide and security policy
-9. Preparation to deploy API as serverless function to Vercel
+Beyond development tooling, projects generated with this template include the code, documentation, and configuration of a fully functioning application and service. This reference implementation serves as a starting point for your own business logic with modern patterns and enterprise practices already in place:
+
+1. Usable as library with "Hello" module exposing a simple service
+2. Command-line interface (CLI) with [Typer](https://typer.tiangolo.com/)
+3. Versioned webservice API with [FastAPI](https://fastapi.tiangolo.com/)
+4. [Interactive Jupyter notebook](https://jupyter.org/) and [reactive Marimo notebook](https://marimo.io/)
+5. Simple Web UI with [Streamlit](https://streamlit.io/)
+6. Configuration to run the CLI and API in a Docker container including setup for [Docker Compose](https://docs.docker.com/get-started/docker-concepts/the-basics/what-is-docker-compose/)
+7. Validation and settings management with [pydantic](https://docs.pydantic.dev/)
+8. Info command enabling to inspect the runtime, compiled settings, and further info provided dynamically by modules
+9. Health endpoint exposing system health dynamically aggregated from all modules and dependencies
+10. Flexible logging and instrumentation, including support for [Sentry](https://sentry.io/) and [Logfire](https://logfire.dev/) 
+11. Modular architecture including auto-registration of services, CLI commands and API routes exposed by modules
+12. Documentation including dynamic badges, setup instructions, contribution guide and security policy
 
 Explore [here](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example) for what's generated out of the box.
 
@@ -276,7 +297,7 @@ The following examples run from source - clone this repository using
 from dotenv import load_dotenv
 from rich.console import Console
 
-from oe_python_template_example import Service
+from oe_python_template_example.hello import Service
 
 console = Console()
 
@@ -362,13 +383,15 @@ uvx oe-python-template-example --help
 Execute commands:
 
 ```shell
-uvx oe-python-template-example hello-world
-uvx oe-python-template-example echo --help
-uvx oe-python-template-example echo "Lorem"
-uvx oe-python-template-example echo "Lorem" --json
-uvx oe-python-template-example openapi
-uvx oe-python-template-example openapi --output-format=json
-uvx oe-python-template-example serve
+uvx oe-python-template-example hello world
+uvx oe-python-template-example hello echo --help
+uvx oe-python-template-example hello echo "Lorem"
+uvx oe-python-template-example hello echo "Lorem" --json
+uvx oe-python-template-example system info
+uvx oe-python-template-example system health
+uvx oe-python-template-example system openapi
+uvx oe-python-template-example system openapi --output-format=json
+uvx oe-python-template-example system serve
 ```
 
 See the [reference documentation of the CLI](https://oe-python-template-example.readthedocs.io/en/latest/cli_reference.html) for detailed documentation of all CLI commands and options.
@@ -391,19 +414,21 @@ You can as well run the CLI within Docker.
 
 ```shell
 docker run helmuthva/oe-python-template-example --help
-docker run helmuthva/oe-python-template-example hello-world
-docker run helmuthva/oe-python-template-example echo --help
-docker run helmuthva/oe-python-template-example echo "Lorem"
-docker run helmuthva/oe-python-template-example echo "Lorem" --json
-docker run helmuthva/oe-python-template-example openapi
-docker run helmuthva/oe-python-template-example openapi --output-format=json
-docker run helmuthva/oe-python-template-example serve
+docker run helmuthva/oe-python-template-example hello world
+docker run helmuthva/oe-python-template-example hello echo --help
+docker run helmuthva/oe-python-template-example hello echo "Lorem"
+docker run helmuthva/oe-python-template-example hello echo "Lorem" --json
+docker run helmuthva/oe-python-template-example system info
+docker run helmuthva/oe-python-template-example system health
+docker run helmuthva/oe-python-template-example system openapi
+docker run helmuthva/oe-python-template-example system openapi --output-format=json
+docker run helmuthva/oe-python-template-example system serve
 ```
 
 Execute command:
 
 ```shell
-docker run --env THE_VAR=MY_VALUE helmuthva/oe-python-template-example echo "Lorem Ipsum"
+docker run --env THE_VAR=MY_VALUE helmuthva/oe-python-template-example hello echo "Lorem Ipsum"
 ```
 
 Or use docker compose
@@ -412,12 +437,14 @@ The .env is passed through from the host to the Docker container.
 
 ```shell
 docker compose run --remove-orphans oe-python-template-example --help
-docker compose run --remove-orphans oe-python-template-example hello-world
-docker compose run --remove-orphans oe-python-template-example echo --help
-docker compose run --remove-orphans oe-python-template-example echo "Lorem"
-docker compose run --remove-orphans oe-python-template-example echo "Lorem" --json
-docker compose run --remove-orphans oe-python-template-example openapi
-docker compose run --remove-orphans oe-python-template-example openapi --output-format=json
+docker compose run --remove-orphans oe-python-template-example hello world
+docker compose run --remove-orphans oe-python-template-example hello echo --help
+docker compose run --remove-orphans oe-python-template-example hello echo "Lorem"
+docker compose run --remove-orphans oe-python-template-example hello echo "Lorem" --json
+docker compose run --remove-orphans oe-python-template-example system info
+docker compose run --remove-orphans oe-python-template-example system health
+docker compose run --remove-orphans oe-python-template-example system openapi
+docker compose run --remove-orphans oe-python-template-example system openapi --output-format=json
 echo "Running OE Python Template Example's API container as a daemon ..."
 docker compose up -d
 echo "Waiting for the API server to start ..."
@@ -426,7 +453,7 @@ echo "Checking health of v1 API ..."
 curl http://127.0.0.1:8000/api/v1/healthz
 echo ""
 echo "Saying hello world with v1 API ..."
-curl http://127.0.0.1:8000/api/v1/hello-world
+curl http://127.0.0.1:8000/api/v1/hello/world
 echo ""
 echo "Swagger docs of v1 API ..."
 curl http://127.0.0.1:8000/api/v1/docs
@@ -435,7 +462,7 @@ echo "Checking health of v2 API ..."
 curl http://127.0.0.1:8000/api/v2/healthz
 echo ""
 echo "Saying hello world with v1 API ..."
-curl http://127.0.0.1:8000/api/v2/hello-world
+curl http://127.0.0.1:8000/api/v2/hello/world
 echo ""
 echo "Swagger docs of v2 API ..."
 curl http://127.0.0.1:8000/api/v2/docs

oe_python_template_example-0.3.7.dist-info/RECORD

@@ -0,0 +1,35 @@
+oe_python_template_example/__init__.py,sha256=_Z3Xb-x95UODU66avOiwROVaouk_s0ZNB25KFnPoS40,226
+oe_python_template_example/api.py,sha256=_DcnOEWe_MJTUWZroRnXeCh9RuBm_-x4edONWHoNBlE,2100
+oe_python_template_example/cli.py,sha256=rNcaCyYkm5_e-ITJJLUKvJfJ_RsGXQk0dnfiFCifTq8,679
+oe_python_template_example/constants.py,sha256=fm8J1LIYF9B4Ur3r5PoUdHyPSjIXWuNydHVoCbz9Jx8,171
+oe_python_template_example/hello/__init__.py,sha256=7C7gIdxkydk79-4QPyVqyUHhqP3RMFShSptzE_2J9jo,289
+oe_python_template_example/hello/_api.py,sha256=B4gCojmEkvh-ScKPz0rXW70r4gVvg7SX2dfbZpUd2vU,2302
+oe_python_template_example/hello/_cli.py,sha256=D1RZyz8sk7wpH1a9VDx1QtsNorOr9owxK8N7SxaaMWM,1200
+oe_python_template_example/hello/_constants.py,sha256=6aRleAIcdgC13TeTzI07YwjoSwqGb2g131dw8aEoM4I,109
+oe_python_template_example/hello/_models.py,sha256=JtI7wGT72u23NOxFa-oeWzdyiMg7PnHL5eg22im2_yQ,574
+oe_python_template_example/hello/_service.py,sha256=GPtJjGBYK1--5UPS3PcEpypHM-ka-xjDjHpDzqFHhoc,3062
+oe_python_template_example/hello/_settings.py,sha256=kvXqqYCKkT42FkiszE5MOChdsTJhC0YJfZnyLKXEtbA,992
+oe_python_template_example/system/__init__.py,sha256=NNgODkr7AyJjTTJiv3pys7o2z6xi1G96g0vnsxVhlI4,427
+oe_python_template_example/system/_api.py,sha256=rE9Aau3IIHXdEkOBUXOwJ7SxN3cZpgtYEuojnSWfT_4,3687
+oe_python_template_example/system/_cli.py,sha256=J_4upBBdbSxbONPYmOZPbuhZcKjfnPIUeZpp0L7lY-Q,4846
+oe_python_template_example/system/_service.py,sha256=e08VPguXKz2RhyhTbIw1ncSpE6zwKUr1xLM2WZC9u7k,6287
+oe_python_template_example/system/_settings.py,sha256=MwMAJYifJ6jGImeSh4e9shmIXmiUSuQGHXz_Ts0mSdk,901
+oe_python_template_example/utils/__init__.py,sha256=rHdmSS21CtvF3AXPMSCZO17FTzxPDo-NiKZ5AjVU9b0,1449
+oe_python_template_example/utils/_api.py,sha256=w3hPQK1pL2gBI4_1qNWNa2b4S_oH-8mY-ckRX0KrCWM,617
+oe_python_template_example/utils/_cli.py,sha256=J_mFtXZ1gGeovGrE5i3wlokTOBfiTTKEz5magiRP7GA,2091
+oe_python_template_example/utils/_console.py,sha256=u0-utcdRmVu4rabrYUyNOx8yPxLhxB3E92m22kSCwPQ,293
+oe_python_template_example/utils/_constants.py,sha256=1ocbciHjhmy66uHrTw6p-fbBq_wLl1HaUSu4oTgt8mo,1737
+oe_python_template_example/utils/_di.py,sha256=KdjiD4xZ_QSfbddkKWwsPJmG5YrIg6dzuBrlsd-FhxA,2189
+oe_python_template_example/utils/_health.py,sha256=35QOWe2r5InrEpGtuVMym9dI5aRHS0HWf4BHBRAUIj0,4102
+oe_python_template_example/utils/_log.py,sha256=ZW4gs540SdjVK-2KeheLfDY15d_3xpO5FyGn7wTXyaM,3592
+oe_python_template_example/utils/_logfire.py,sha256=g2tR60XgpdRs_UwDpqkwWm6ErUBcV7lPFBJdvgfTuu0,2022
+oe_python_template_example/utils/_process.py,sha256=40R0NZMqJUn0iUPERzohSUpJgU1HcJApIg1HipIxFCw,941
+oe_python_template_example/utils/_sentry.py,sha256=Y4hZ-PeBOdR3iRhoXW9j0tbWsYf07460UG8OVTKH1mU,3128
+oe_python_template_example/utils/_service.py,sha256=atHAejvBucKXjzhsMSdOBBFa7rRD74zcV70Pp0pl0Tg,1038
+oe_python_template_example/utils/_settings.py,sha256=5K1pnp-AxMQbktREb3bXDmqgrOx_L4EJIgjPQfqH4sE,2294
+oe_python_template_example/utils/boot.py,sha256=TBgmqbtIryQz0cAozYzxhYQRIldfbJ6v9R-rH6sO9mY,2696
+oe_python_template_example-0.3.7.dist-info/METADATA,sha256=fHz4k1yEXUdTCmimGQ3ANZQ4e5kWKxxO5vZ4Gb2VqZE,33191
+oe_python_template_example-0.3.7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+oe_python_template_example-0.3.7.dist-info/entry_points.txt,sha256=S2eCPB45b1Wgj_GsDRFAN-e4h7dBA5UPxT8od98erDE,82
+oe_python_template_example-0.3.7.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
+oe_python_template_example-0.3.7.dist-info/RECORD,,

oe_python_template_example/models.py

@@ -1,44 +0,0 @@
-"""Models used throughout OE Python Template Example'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