oe-python-template 0.3.5__tar.gz → 0.3.6__tar.gz

{oe_python_template-0.3.5 → oe_python_template-0.3.6}/.copier-answers.yml

@@ -1,4 +1,4 @@
-_commit: v0.3.4-1-gd342382
+_commit: v0.3.5-3-gc123fae
 _src_path: .
 author_email: helmuthva@gmail.com
 author_github_username: helmut-hoffer-von-ankershoffen

{oe_python_template-0.3.5 → oe_python_template-0.3.6}/.pre-commit-config.yaml

@@ -53,6 +53,7 @@ repos:
       - id: name-tests-test
       - id: requirements-txt-fixer
       - id: trailing-whitespace
+        exclude: "docs/source/_static"
   - repo: https://github.com/Yelp/detect-secrets
     rev: v1.5.0
     hooks:

{oe_python_template-0.3.5 → oe_python_template-0.3.6}/.secrets.baseline

@@ -123,5 +123,5 @@
     }
   ],
   "results": {},
-  "generated_at": "2025-03-08T19:00:27Z"
+  "generated_at": "2025-03-11T07:50:30Z"
 }

{oe_python_template-0.3.5 → oe_python_template-0.3.6}/CHANGELOG.md

@@ -1,5 +1,23 @@
 [🧠 OE Python Template](https://oe-python-template.readthedocs.io/en/latest/)
 
+## [0.3.6](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.3.5..0.3.6) - 2025-03-11
+
+### ⛰️  Features
+
+- Api incl. swagger within sphinx - ([69138f1](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/69138f132f5492cea5c6d61bcc700fd483cf582a))
+
+### 📚 Documentation
+
+- Placing of openapi specs for sphinx - ([da85ba0](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/da85ba0300e388de25d2feb820d2600f74f22612))
+
+### 🧪 Testing
+
+- Tests for serve and openapi commands - ([fee2798](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/fee2798c4e93223f062bd108f476728f617b8461))
+
+## New Contributors ❤️
+
+* @helmut-hoffer-von-ankershoffen made their first contribution
+
 ## [0.3.4](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.3.3..v0.3.4) - 2025-03-08
 
 ### 📚 Documentation

{oe_python_template-0.3.5 → oe_python_template-0.3.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template
-Version: 0.3.5
+Version: 0.3.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/
@@ -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

oe_python_template-0.3.6/RELEASE_NOTES.md

@@ -0,0 +1,16 @@
+## [0.3.6](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.3.5..v0.3.6) - 2025-03-11
+
+### ⛰️  Features
+
+- Api incl. swagger within sphinx - ([69138f1](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/69138f132f5492cea5c6d61bcc700fd483cf582a))
+
+### 📚 Documentation
+
+- Placing of openapi specs for sphinx - ([da85ba0](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/da85ba0300e388de25d2feb820d2600f74f22612))
+
+### 🧪 Testing
+
+- Tests for serve and openapi commands - ([fee2798](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/fee2798c4e93223f062bd108f476728f617b8461))
+
+
+

oe_python_template-0.3.6/VERSION

@@ -0,0 +1 @@
+0.3.6

oe_python_template-0.3.6/docs/source/_static/openapi.json

@@ -0,0 +1,185 @@
+{
+  "openapi": "3.1.0",
+  "info": {
+    "title": "OE Python Template",
+    "termsOfService": "https://oe-python-template.readthedocs.io/en/latest/",
+    "contact": {
+      "name": "Helmut Hoffer von Ankershoffen",
+      "url": "https://github.com/helmut-hoffer-von-ankershoffen",
+      "email": "helmuthva@gmail.com"
+    },
+    "version": "1.0.0"
+  },
+  "paths": {
+    "/hello-world": {
+      "get": {
+        "tags": [
+          "Basics"
+        ],
+        "summary": "Hello World",
+        "description": "Return a hello world message.\n\nReturns:\n    HelloWorldResponse: A response containing the hello world message.",
+        "operationId": "hello_world_hello_world_get",
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HelloWorldResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/echo": {
+      "post": {
+        "tags": [
+          "Basics"
+        ],
+        "summary": "Echo",
+        "description": "Echo back the provided text.\n\nArgs:\n    request (EchoRequest): The request containing the text to echo back.\n\nReturns:\n    EchoResponse: A response containing the echoed text.\n\nRaises:\n    422 Unprocessable Entity: If text is not provided or empty.",
+        "operationId": "echo_echo_post",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/EchoRequest"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/EchoResponse"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Validation Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HTTPValidationError"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "EchoRequest": {
+        "properties": {
+          "text": {
+            "type": "string",
+            "minLength": 1,
+            "title": "Text",
+            "description": "The text to echo back",
+            "examples": [
+              "Hello, world!"
+            ]
+          }
+        },
+        "type": "object",
+        "required": [
+          "text"
+        ],
+        "title": "EchoRequest",
+        "description": "Request model for echo endpoint."
+      },
+      "EchoResponse": {
+        "properties": {
+          "message": {
+            "type": "string",
+            "minLength": 1,
+            "title": "Message",
+            "description": "The message content",
+            "examples": [
+              "Hello, world!"
+            ]
+          }
+        },
+        "type": "object",
+        "required": [
+          "message"
+        ],
+        "title": "EchoResponse",
+        "description": "Response model for echo endpoint."
+      },
+      "HTTPValidationError": {
+        "properties": {
+          "detail": {
+            "items": {
+              "$ref": "#/components/schemas/ValidationError"
+            },
+            "type": "array",
+            "title": "Detail"
+          }
+        },
+        "type": "object",
+        "title": "HTTPValidationError"
+      },
+      "HelloWorldResponse": {
+        "properties": {
+          "message": {
+            "type": "string",
+            "title": "Message",
+            "description": "The hello world message",
+            "examples": [
+              "Hello, world!"
+            ]
+          }
+        },
+        "type": "object",
+        "required": [
+          "message"
+        ],
+        "title": "HelloWorldResponse",
+        "description": "Response model for hello-world endpoint."
+      },
+      "ValidationError": {
+        "properties": {
+          "loc": {
+            "items": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "integer"
+                }
+              ]
+            },
+            "type": "array",
+            "title": "Location"
+          },
+          "msg": {
+            "type": "string",
+            "title": "Message"
+          },
+          "type": {
+            "type": "string",
+            "title": "Error Type"
+          }
+        },
+        "type": "object",
+        "required": [
+          "loc",
+          "msg",
+          "type"
+        ],
+        "title": "ValidationError"
+      }
+    }
+  }
+}

oe_python_template-0.3.6/docs/source/_static/openapi.yaml

@@ -0,0 +1,131 @@
+components:
+  schemas:
+    EchoRequest:
+      description: Request model for echo endpoint.
+      properties:
+        text:
+          description: The text to echo back
+          examples:
+          - Hello, world!
+          minLength: 1
+          title: Text
+          type: string
+      required:
+      - text
+      title: EchoRequest
+      type: object
+    EchoResponse:
+      description: Response model for echo endpoint.
+      properties:
+        message:
+          description: The message content
+          examples:
+          - Hello, world!
+          minLength: 1
+          title: Message
+          type: string
+      required:
+      - message
+      title: EchoResponse
+      type: object
+    HTTPValidationError:
+      properties:
+        detail:
+          items:
+            $ref: '#/components/schemas/ValidationError'
+          title: Detail
+          type: array
+      title: HTTPValidationError
+      type: object
+    HelloWorldResponse:
+      description: Response model for hello-world endpoint.
+      properties:
+        message:
+          description: The hello world message
+          examples:
+          - Hello, world!
+          title: Message
+          type: string
+      required:
+      - message
+      title: HelloWorldResponse
+      type: object
+    ValidationError:
+      properties:
+        loc:
+          items:
+            anyOf:
+            - type: string
+            - type: integer
+          title: Location
+          type: array
+        msg:
+          title: Message
+          type: string
+        type:
+          title: Error Type
+          type: string
+      required:
+      - loc
+      - msg
+      - type
+      title: ValidationError
+      type: object
+info:
+  contact:
+    email: helmuthva@gmail.com
+    name: Helmut Hoffer von Ankershoffen
+    url: https://github.com/helmut-hoffer-von-ankershoffen
+  termsOfService: https://oe-python-template.readthedocs.io/en/latest/
+  title: OE Python Template
+  version: 1.0.0
+openapi: 3.1.0
+paths:
+  /echo:
+    post:
+      description: "Echo back the provided text.\n\nArgs:\n    request 
+(EchoRequest):\
+        \ The request containing the text to echo back.\n\nReturns:\n    
+EchoResponse:\
+        \ A response containing the echoed text.\n\nRaises:\n    422 
+Unprocessable\
+        \ Entity: If text is not provided or empty."
+      operationId: echo_echo_post
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/EchoRequest'
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/EchoResponse'
+          description: Successful Response
+        '422':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      summary: Echo
+      tags:
+      - Basics
+  /hello-world:
+    get:
+      description: "Return a hello world message.\n\nReturns:\n    
+HelloWorldResponse:\
+        \ A response containing the hello world message."
+      operationId: hello_world_hello_world_get
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/HelloWorldResponse'
+          description: Successful Response
+      summary: Hello World
+      tags:
+      - Basics

oe_python_template-0.3.6/docs/source/api.rst

@@ -0,0 +1,5 @@
+API
+===
+
+.. swagger-plugin:: _static/openapi.yaml
+    :full-page:

{oe_python_template-0.3.5 → oe_python_template-0.3.6}/docs/source/conf.py

@@ -20,12 +20,13 @@ extensions = [
     "sphinx_inline_tabs",
     "sphinx_mdinclude",
     "sphinxext.opengraph",
+    "swagger_plugin_for_sphinx",  # https://github.com/SAP/swagger-plugin-for-sphinx?tab=readme-ov-file
 ]
 
 project = "oe-python-template"
 author = "Helmut Hoffer von Ankershoffen"
 copyright = f" (c) 2025-{datetime.now(UTC).year}, {author}"  # noqa: A001
-version = "0.3.5"
+version = "0.3.6"
 release = version
 github_username = "helmut-hoffer-von-ankershoffen"
 github_repository = "oe-python-template"

{oe_python_template-0.3.5 → oe_python_template-0.3.6}/docs/source/index.rst

@@ -11,6 +11,7 @@
    :maxdepth: 2
 
    main
+   api
    reference
    release-notes
    contributing

{oe_python_template-0.3.5 → oe_python_template-0.3.6}/noxfile.py

@@ -59,7 +59,13 @@ def docs(session: nox.Session) -> None:
     footer = Path("_readme_footer.md").read_text(encoding="utf-8")
     readme_content = f"{header}\n\n{main}\n\n{footer}"
     Path("README.md").write_text(readme_content, encoding="utf-8")
+    # Dump openapi schema to file
+    with Path("docs/source/_static/openapi.yaml").open("w", encoding="utf-8") as f:
+        session.run("oe-python-template", "openapi", stdout=f, external=True)
+    with Path("docs/source/_static/openapi.json").open("w", encoding="utf-8") as f:
+        session.run("oe-python-template", "openapi", "--output-format=json", stdout=f, external=True)
     # Build docs
+    session.run("make", "-C", "docs", "clean", external=True)
     session.run("make", "-C", "docs", "html", external=True)
 
 

{oe_python_template-0.3.5 → oe_python_template-0.3.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "oe-python-template"
-version = "0.3.5"
+version = "0.3.6"
 description = "🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling."
 readme = "README.md"
 authors = [
@@ -62,6 +62,7 @@ classifiers = [
 requires-python = ">=3.11, <4.0"
 
 dependencies = [
+    "fastapi[standard,all]>=0.115.11",
     "pydantic>=2.10.6",
     "python-dotenv>=1.0.1",
     "typer>=0.15.1",
@@ -98,6 +99,7 @@ dev = [
     "enum-tools>=0.12.0",
     "furo>=2024.8.6",
     "git-cliff>=2.8.0",
+    "matplotlib>=3.10.1",
     "mypy>=1.5.0",
     "nox[uv]>=2025.2.9",
     "pip-audit>=2.8.0",
@@ -109,6 +111,7 @@ dev = [
     "pytest-cov>=6.0.0",
     "pytest-docker>=3.2.0",
     "pytest-env>=1.1.5",
+    "pytest-regressions>=2.7.0",
     "pytest-xdist[psutil]>=3.6.1",
     "ruff>=0.9.10",
     "sphinx>=8.2.3",
@@ -116,14 +119,13 @@ dev = [
     "sphinx-copybutton>=0.5.2",
     "sphinx-inline-tabs>=2023.4.21",
     "sphinx-mdinclude>=0.6.2",
-    "sphinxext.opengraph>=0.9.1",
     "sphinx-pydantic>=0.1.1",
     "sphinx-rtd-theme>=3.0.2",
     "sphinx-toolbox>=3.9.0",
-    "sphinxext-opengraph>=0.9.1",
+    "sphinxext.opengraph>=0.9.1",
+    "swagger-plugin-for-sphinx>=5.1.0",
     "tomli>=2.1.0",
-    "matplotlib>=3.10.1",
-    "pytest-regressions>=2.7.0",
+    "types-pyyaml>=6.0.12.20241230",
 ]
 
 [tool.ruff]
@@ -242,7 +244,7 @@ source = ["src/"]
 
 
 [tool.bumpversion]
-current_version = "0.3.5"
+current_version = "0.3.6"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"

{oe_python_template-0.3.5 → oe_python_template-0.3.6}/sonar-project.properties

@@ -1,6 +1,6 @@
 sonar.projectKey=helmut-hoffer-von-ankershoffen_oe-python-template
 sonar.organization=helmut-hoffer-von-ankershoffen
-sonar.projectVersion=0.3.5
+sonar.projectVersion=0.3.6
 sonar.projectDescription=🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling.
 sonar.links.homepage=https://oe-python-template.readthedocs.io/en/latest/
 sonar.links.scm=https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template

oe_python_template-0.3.6/src/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-0.3.5 → oe_python_template-0.3.6}/src/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 → oe_python_template-0.3.6}/template/.pre-commit-config.yaml.jinja

@@ -53,6 +53,7 @@ repos:
       - id: name-tests-test
       - id: requirements-txt-fixer
       - id: trailing-whitespace
+        exclude: "docs/source/_static"
   - repo: https://github.com/Yelp/detect-secrets
     rev: v1.5.0
     hooks:

{oe_python_template-0.3.5 → oe_python_template-0.3.6}/template/CONTRIBUTING.md.jinja

@@ -119,7 +119,7 @@ Update scaffold from template
 copier update --trust --skip-tasks --skip-answered
 ```
 
-### Updating demo application contained within oe-python-template
+### Updating demo application contained within {{ project_name_kebab_case }}
 
 ```shell
 copier copy -r HEAD . . --force --trust

oe_python_template-0.3.6/template/docs/source/api.rst.jinja

@@ -0,0 +1,5 @@
+API
+===
+
+.. swagger-plugin:: _static/openapi.yaml
+    :full-page: