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

oe_python_template/api.py

@@ -0,0 +1,87 @@
+"""FastAPI application with REST API endpoints.
+
+This module provides a FastAPI application with several endpoints:
+- A hello-world endpoint that returns a greeting message
+- An echo endpoint that echoes back the provided text
+
+The endpoints use Pydantic models for request and response validation.
+"""
+
+from fastapi import FastAPI
+from pydantic import BaseModel, Field
+
+from oe_python_template import Service
+
+HELLO_WORLD_EXAMPLE = "Hello, world!"
+
+
+app = FastAPI(
+    version="1.0.0",
+    title="OE Python Template",
+    contact={
+        "name": "Helmut Hoffer von Ankershoffen",
+        "email": "helmuthva@gmail.com",
+        "url": "https://github.com/helmut-hoffer-von-ankershoffen",
+    },
+    terms_of_service="https://oe-python-template.readthedocs.io/en/latest/",
+)
+
+
+class HelloWorldResponse(BaseModel):
+    """Response model for hello-world endpoint."""
+
+    message: str = Field(
+        ...,
+        description="The hello world message",
+        examples=[HELLO_WORLD_EXAMPLE],
+    )
+
+
+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],
+    )
+
+
+@app.get("/hello-world", tags=["Basics"])
+async def hello_world() -> HelloWorldResponse:
+    """
+    Return a hello world message.
+
+    Returns:
+        HelloWorldResponse: A response containing the hello world message.
+    """
+    return HelloWorldResponse(message=Service.get_hello_world())
+
+
+@app.post("/echo", tags=["Basics"])
+async def echo(request: EchoRequest) -> EchoResponse:
+    """
+    Echo back the provided text.
+
+    Args:
+        request (EchoRequest): The request containing the text to echo back.
+
+    Returns:
+        EchoResponse: A response containing the echoed text.
+
+    Raises:
+        422 Unprocessable Entity: If text is not provided or empty.
+    """
+    return EchoResponse(message=request.text)

oe_python_template/cli.py

@@ -3,9 +3,12 @@
 from typing import Annotated
 
 import typer
+import uvicorn
+import yaml
 from rich.console import Console
 
 from oe_python_template import Service, __version__
+from oe_python_template.api import app as api
 
 console = Console()
 
@@ -37,6 +40,36 @@ def hello_world() -> None:
     console.print(Service.get_hello_world())
 
 
+@cli.command()
+def serve(
+    host: Annotated[str, typer.Option(help="Host to bind the server to")] = "127.0.0.1",
+    port: Annotated[int, typer.Option(help="Port to bind the server to")] = 8000,
+    reload: Annotated[bool, typer.Option(help="Enable auto-reload")] = True,
+) -> None:
+    """Start the API server."""
+    console.print(f"Starting API server at http://{host}:{port}")
+    uvicorn.run(
+        "oe_python_template.api:app",
+        host=host,
+        port=port,
+        reload=reload,
+    )
+
+
+@cli.command()
+def openapi(
+    output_format: Annotated[
+        str, typer.Option(help="Output format (yaml or json), defaults to yaml", case_sensitive=False)
+    ] = "yaml",
+) -> None:
+    """Dump the OpenAPI specification to stdout (YAML by default)."""
+    schema = api.openapi()
+    if output_format.lower() == "json":
+        console.print_json(data=schema)
+    else:
+        console.print(yaml.dump(schema, default_flow_style=False), end="")
+
+
 def _apply_cli_settings(cli: typer.Typer, epilog: str) -> None:
     """Add epilog to all typers in the tree and configure default behavior."""
     cli.info.epilog = epilog

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template
-Version: 0.3.5
+Version: 0.3.7
 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/
@@ -48,6 +48,7 @@ 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: pydantic>=2.10.6
 Requires-Dist: python-dotenv>=1.0.1
 Requires-Dist: typer>=0.15.1
@@ -183,7 +184,7 @@ uvx oe-python-template hello-world --help    # help for specific command
 
 * Copier template to scaffold Python projects compliant with best practices and modern tooling.
 * Various Examples:
-  - [Simple Python script]https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/script.py)
+  - [Simple Python script]({ github_repository_url_https }/blob/main/examples/script.py)
   - [Streamlit web application](https://oe-python-template.streamlit.app/) deployed on [Streamlit Community Cloud](https://streamlit.io/cloud)
   - [Jupyter](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/notebook.ipynb) and [Marimo](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/notebook.py) notebook
 * [Complete reference documenation](https://oe-python-template.readthedocs.io/en/latest/reference.html) on Read the Docs

oe_python_template-0.3.7.dist-info/RECORD

@@ -0,0 +1,10 @@
+oe_python_template/__init__.py,sha256=XJAycUgDI2K8T0jVcXbaGfx2UAQJZbYcvJ_SYSqFyDA,315
+oe_python_template/api.py,sha256=NbjvA9_VWzOASi31SY62DFQBrzcMpwxzWoqcuiQ6LZs,2179
+oe_python_template/cli.py,sha256=t6nV6jHzYmrwz_PkNDj7njSElqd3jeQc0wqELBxxuBw,2351
+oe_python_template/constants.py,sha256=Z1c06l5DeRuFxYVLHihHHTYvr8_Qh0nyzVKOe5X3ZNs,350
+oe_python_template/service.py,sha256=p59ch0g81LpsRvL-m-vLPuk0Rf6EYsZfZJ_OCA9vWzQ,500
+oe_python_template-0.3.7.dist-info/METADATA,sha256=qBlv1KLbMAUOKncNmBHsVoS0nOg9iiSGm1POexk5JTY,19227
+oe_python_template-0.3.7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+oe_python_template-0.3.7.dist-info/entry_points.txt,sha256=IroSSWhLGxus9rxcashkYQda39TTvf7LbUMYtOKXUBE,66
+oe_python_template-0.3.7.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
+oe_python_template-0.3.7.dist-info/RECORD,,

oe_python_template-0.3.5.dist-info/RECORD

@@ -1,9 +0,0 @@
-oe_python_template/__init__.py,sha256=XJAycUgDI2K8T0jVcXbaGfx2UAQJZbYcvJ_SYSqFyDA,315
-oe_python_template/cli.py,sha256=5tUw70ffHL-ot0rM7g6BmsVhn9IKBQXwbWU0-n9-wb4,1319
-oe_python_template/constants.py,sha256=Z1c06l5DeRuFxYVLHihHHTYvr8_Qh0nyzVKOe5X3ZNs,350
-oe_python_template/service.py,sha256=p59ch0g81LpsRvL-m-vLPuk0Rf6EYsZfZJ_OCA9vWzQ,500
-oe_python_template-0.3.5.dist-info/METADATA,sha256=a0cicobo8zqGnENxF8RcTHVKQk1-hYazMSXoVj4Zm_U,19216
-oe_python_template-0.3.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-oe_python_template-0.3.5.dist-info/entry_points.txt,sha256=IroSSWhLGxus9rxcashkYQda39TTvf7LbUMYtOKXUBE,66
-oe_python_template-0.3.5.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
-oe_python_template-0.3.5.dist-info/RECORD,,