aignostics 0.0.2__tar.gz → 0.0.4__tar.gz

{aignostics-0.0.2 → aignostics-0.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aignostics
-Version: 0.0.2
+Version: 0.0.4
 Summary: 🔬 Python SDK providing access to Aignostics AI services.
 Project-URL: Homepage, https://aignostics.readthedocs.io/en/latest/
 Project-URL: Documentation, https://aignostics.readthedocs.io/en/latest/
@@ -106,36 +106,44 @@ Description-Content-Type: text/markdown
 
 Python SDK providing access to Aignostics AI services.
 
-This [Copier](https://copier.readthedocs.io/en/stable/) template enables you to quickly generate a Python package with fully functioning build and test automation.
-Projects generated from this template can be [easily updated](https://copier.readthedocs.io/en/stable/updating/) to benefit from improvements and new features of the template.
-
-Features:
-1. Package management with [uv](https://github.com/astral-sh/uv)
-2. Code formatting with [Ruff](https://github.com/astral-sh/ruff)
-3. Linting with [Ruff](https://github.com/astral-sh/ruff)
-4. Static type checking with [mypy](https://mypy.readthedocs.io/en/stable/)
-5. Complete set of [pre-commit](https://pre-commit.com/) hooks including [detect-secrets](https://github.com/Yelp/detect-secrets) and [pygrep](https://github.com/pre-commit/pygrep-hooks)
-6. Unit and E2E testing with [pytest](https://docs.pytest.org/en/stable/) including parallel test execution
-7. Matrix testing in multiple environments with [nox](https://nox.thea.codes/en/stable/)
-8. Test coverage reported with [Codecov](https://codecov.io/) and published as release artifact
-9. CI/CD pipeline automated with [GitHub Actions](https://github.com/features/actions)
-10. CI/CD pipeline can be run locally with [act](https://github.com/nektos/act)
-11. Code quality and security checks with [SonarQube](https://www.sonarsource.com/products/sonarcloud) and [GitHub CodeQL](https://codeql.github.com/)
-12. Dependency monitoring with [pip-audit](https://pypi.org/project/pip-audit/), [Renovate](https://github.com/renovatebot/renovate), and [GitHub Dependabot](https://docs.github.com/en/code-security/getting-started/dependabot-quickstart-guide)
-13. Licenses of dependencies extracted with [pip-licenses](https://pypi.org/project/pip-licenses/) and published as release artifacts in CSV and JSON format for compliance checks
-14. Software Bill of Materials (SBOM) generated with [cyclonedx-python](https://github.com/CycloneDX/cyclonedx-python) and published as release artifact
-15. Version and release management with [bump-my-version](https://callowayproject.github.io/bump-my-version/)
-16. Changelog and release notes generated with [git-cliff](https://git-cliff.org/)
-17. Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation and PDF export
-18. Documentation published to [Read The Docs](https://readthedocs.org/)
-19. Interactive OpenAPI specification with [Swagger](https://swagger.io/)
-20. Python package published to [PyPI](https://pypi.org/)
-21. 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)
-22. One-click development environments with [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) and [GitHub Codespaces](https://github.com/features/codespaces)
-23. Settings for use with [VSCode](https://code.visualstudio.com/)
-24. Settings and custom instructions for use with [GitHub Copilot](https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
-
-The generated project includes code, documentation and configuration of a fully functioning demo-application and service, which can be used as a starting point for your own project.
+### Scaffolding
+
+This [Copier](https://copier.readthedocs.io/en/stable/) template enables you to quickly generate (scaffold) a Python package with fully functioning build and test automation:
+
+1. Projects generated from this template can be [easily updated](https://copier.readthedocs.io/en/stable/updating/) to benefit from improvements and new features of the template.
+2. During project generation, you can flexibly configure naming of the Python distribution, import package, main author, GitHub repository, organization, and many other aspects to match your specific requirements (see [copier.yml](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/copier.yml) for all available options).
+
+### Development Infrastructure
+
+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/)
+3. Complete set of [pre-commit](https://pre-commit.com/) hooks including [detect-secrets](https://github.com/Yelp/detect-secrets) and [pygrep](https://github.com/pre-commit/pygrep-hooks)
+4. Unit and E2E testing with [pytest](https://docs.pytest.org/en/stable/) including parallel test execution
+5. Matrix testing in multiple environments with [nox](https://nox.thea.codes/en/stable/)
+6. Test coverage reported with [Codecov](https://codecov.io/) and published as release artifact
+7. CI/CD pipeline automated with [GitHub Actions](https://github.com/features/actions)
+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 with [pip-audit](https://pypi.org/project/pip-audit/), [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/) and published as release artifacts in CSV and JSON format for compliance checks
+12. Software Bill of Materials (SBOM) generated with [cyclonedx-python](https://github.com/CycloneDX/cyclonedx-python) and published as release artifact
+13. Version and release management with [bump-my-version](https://callowayproject.github.io/bump-my-version/)
+14. Changelog and release notes generated with [git-cliff](https://git-cliff.org/)
+15. Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation and PDF export
+16. Documentation published to [Read The Docs](https://readthedocs.org/)
+17. Interactive OpenAPI specification with [Swagger](https://swagger.io/)
+18. Python package published to [PyPI](https://pypi.org/)
+19. 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)
+20. One-click development environments with [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) and [GitHub Codespaces](https://github.com/features/codespaces)
+21. Settings for use with [VSCode](https://code.visualstudio.com/)
+22. Settings and custom instructions for use with [GitHub Copilot](https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
+
+### 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/)
@@ -193,9 +201,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
 

{aignostics-0.0.2 → aignostics-0.0.4}/README.md

@@ -45,36 +45,44 @@
 
 Python SDK providing access to Aignostics AI services.
 
-This [Copier](https://copier.readthedocs.io/en/stable/) template enables you to quickly generate a Python package with fully functioning build and test automation.
-Projects generated from this template can be [easily updated](https://copier.readthedocs.io/en/stable/updating/) to benefit from improvements and new features of the template.
-
-Features:
-1. Package management with [uv](https://github.com/astral-sh/uv)
-2. Code formatting with [Ruff](https://github.com/astral-sh/ruff)
-3. Linting with [Ruff](https://github.com/astral-sh/ruff)
-4. Static type checking with [mypy](https://mypy.readthedocs.io/en/stable/)
-5. Complete set of [pre-commit](https://pre-commit.com/) hooks including [detect-secrets](https://github.com/Yelp/detect-secrets) and [pygrep](https://github.com/pre-commit/pygrep-hooks)
-6. Unit and E2E testing with [pytest](https://docs.pytest.org/en/stable/) including parallel test execution
-7. Matrix testing in multiple environments with [nox](https://nox.thea.codes/en/stable/)
-8. Test coverage reported with [Codecov](https://codecov.io/) and published as release artifact
-9. CI/CD pipeline automated with [GitHub Actions](https://github.com/features/actions)
-10. CI/CD pipeline can be run locally with [act](https://github.com/nektos/act)
-11. Code quality and security checks with [SonarQube](https://www.sonarsource.com/products/sonarcloud) and [GitHub CodeQL](https://codeql.github.com/)
-12. Dependency monitoring with [pip-audit](https://pypi.org/project/pip-audit/), [Renovate](https://github.com/renovatebot/renovate), and [GitHub Dependabot](https://docs.github.com/en/code-security/getting-started/dependabot-quickstart-guide)
-13. Licenses of dependencies extracted with [pip-licenses](https://pypi.org/project/pip-licenses/) and published as release artifacts in CSV and JSON format for compliance checks
-14. Software Bill of Materials (SBOM) generated with [cyclonedx-python](https://github.com/CycloneDX/cyclonedx-python) and published as release artifact
-15. Version and release management with [bump-my-version](https://callowayproject.github.io/bump-my-version/)
-16. Changelog and release notes generated with [git-cliff](https://git-cliff.org/)
-17. Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation and PDF export
-18. Documentation published to [Read The Docs](https://readthedocs.org/)
-19. Interactive OpenAPI specification with [Swagger](https://swagger.io/)
-20. Python package published to [PyPI](https://pypi.org/)
-21. 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)
-22. One-click development environments with [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) and [GitHub Codespaces](https://github.com/features/codespaces)
-23. Settings for use with [VSCode](https://code.visualstudio.com/)
-24. Settings and custom instructions for use with [GitHub Copilot](https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
-
-The generated project includes code, documentation and configuration of a fully functioning demo-application and service, which can be used as a starting point for your own project.
+### Scaffolding
+
+This [Copier](https://copier.readthedocs.io/en/stable/) template enables you to quickly generate (scaffold) a Python package with fully functioning build and test automation:
+
+1. Projects generated from this template can be [easily updated](https://copier.readthedocs.io/en/stable/updating/) to benefit from improvements and new features of the template.
+2. During project generation, you can flexibly configure naming of the Python distribution, import package, main author, GitHub repository, organization, and many other aspects to match your specific requirements (see [copier.yml](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/copier.yml) for all available options).
+
+### Development Infrastructure
+
+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/)
+3. Complete set of [pre-commit](https://pre-commit.com/) hooks including [detect-secrets](https://github.com/Yelp/detect-secrets) and [pygrep](https://github.com/pre-commit/pygrep-hooks)
+4. Unit and E2E testing with [pytest](https://docs.pytest.org/en/stable/) including parallel test execution
+5. Matrix testing in multiple environments with [nox](https://nox.thea.codes/en/stable/)
+6. Test coverage reported with [Codecov](https://codecov.io/) and published as release artifact
+7. CI/CD pipeline automated with [GitHub Actions](https://github.com/features/actions)
+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 with [pip-audit](https://pypi.org/project/pip-audit/), [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/) and published as release artifacts in CSV and JSON format for compliance checks
+12. Software Bill of Materials (SBOM) generated with [cyclonedx-python](https://github.com/CycloneDX/cyclonedx-python) and published as release artifact
+13. Version and release management with [bump-my-version](https://callowayproject.github.io/bump-my-version/)
+14. Changelog and release notes generated with [git-cliff](https://git-cliff.org/)
+15. Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation and PDF export
+16. Documentation published to [Read The Docs](https://readthedocs.org/)
+17. Interactive OpenAPI specification with [Swagger](https://swagger.io/)
+18. Python package published to [PyPI](https://pypi.org/)
+19. 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)
+20. One-click development environments with [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) and [GitHub Codespaces](https://github.com/features/codespaces)
+21. Settings for use with [VSCode](https://code.visualstudio.com/)
+22. Settings and custom instructions for use with [GitHub Copilot](https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
+
+### 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/)
@@ -132,9 +140,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
 

{aignostics-0.0.2 → aignostics-0.0.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "aignostics"
-version = "0.0.2"
+version = "0.0.4"
 description = "🔬 Python SDK providing access to Aignostics AI services."
 readme = "README.md"
 authors = [
@@ -125,7 +125,6 @@ dev = [
     "sphinx-copybutton>=0.5.2",
     "sphinx-inline-tabs>=2023.4.21",
     "sphinx-mdinclude>=0.6.2",
-    "sphinx-pydantic>=0.1.1",
     "sphinx-rtd-theme>=3.0.2",
     "sphinx_selective_exclude>=1.0.3",
     "sphinx-toolbox>=3.9.0",
@@ -136,6 +135,12 @@ dev = [
     "watchdog>=6.0.0",
 ]
 
+[tool.uv]
+override-dependencies = [ # https://github.com/astral-sh/uv/issues/4422
+    "rfc3987; sys_platform == 'never'",                 # GPLv3
+]
+
+
 [tool.ruff]
 target-version = "py311"
 preview = true
@@ -248,7 +253,7 @@ source = ["src/"]
 
 
 [tool.bumpversion]
-current_version = "0.0.2"
+current_version = "0.0.4"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"

{aignostics-0.0.2 → aignostics-0.0.4}/src/aignostics/__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__",

{aignostics-0.0.2 → aignostics-0.0.4}/src/aignostics/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 aignostics import Service
+from aignostics import Echo, Health, HealthStatus, Service, Utterance
 
 TITLE = "Aignostics Python SDK"
 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)

{aignostics-0.0.2 → aignostics-0.0.4}/src/aignostics/cli.py

@@ -9,7 +9,7 @@ import uvicorn
 import yaml
 from rich.console import Console
 
-from aignostics import Service, __version__
+from aignostics import Service, Utterance, __version__
 from aignostics.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()

aignostics-0.0.4/src/aignostics/models.py

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

{aignostics-0.0.2 → aignostics-0.0.4}/src/aignostics/service.py

@@ -1,9 +1,11 @@
-"""Service of Aignostics Python SDK."""
+"""Service of Aignostics Python SDK's."""
 
 import os
 
 from dotenv import load_dotenv
 
+from aignostics.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())