oe-python-template-example 0.1.0__tar.gz → 0.1.1__tar.gz

{oe_python_template_example-0.1.0 → oe_python_template_example-0.1.1}/.copier-answers.yml

@@ -1,4 +1,4 @@
-_commit: v0.4.2
+_commit: v0.4.3
 _src_path: gh:helmut-hoffer-von-ankershoffen/oe-python-template
 author_email: helmuthva@gmail.com
 author_github_username: helmut-hoffer-von-ankershoffen

{oe_python_template_example-0.1.0 → oe_python_template_example-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template-example
-Version: 0.1.0
+Version: 0.1.1
 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/
@@ -172,16 +172,14 @@ Executing the command line interface (CLI) in an isolated Python environment is
 ```shell
 uvx oe-python-template-example hello-world     # prints "Hello, world! [..]"
 uvx oe-python-template-example serve           # serves webservice API
+uvx oe-python-template-example serve --port=4711 # serves webservice API on port 4711
 ```
 
-When serving the API, go to [http://127.0.0.1:8000/api/v1/hello-world](http://127.0.0.1:8000/api/v1/hello-world) to see the result.
-
-The API is versioned and provides interactive documentation at [http://127.0.0.1:8000/api/v1/docs](http://127.0.0.1:8000/api/v1/docs) resp. [http://127.0.0.1:8000/api/v2/docs](http://127.0.0.1:8000/api/v2/docs)
-
-
-```shell
+Notes:
+* The API is versioned, mounted at ```/api/v1``` resp. ```/api/v2```
+* While serving the webservice API go to [http://127.0.0.1:8000/api/v1/hello-world](http://127.0.0.1:8000/api/v1/hello-world) to see the respons of the ```hello-world``` operation.
+* Interactive documentation is provided at [http://127.0.0.1:8000/api/docs](http://127.0.0.1:8000/api/docs)
 
-When running the webservice API, goto http://127.0.0.1:8000/api/v1/docs
 
 The CLI provides extensive help:
 

{oe_python_template_example-0.1.0 → oe_python_template_example-0.1.1}/README.md

@@ -111,16 +111,14 @@ Executing the command line interface (CLI) in an isolated Python environment is
 ```shell
 uvx oe-python-template-example hello-world     # prints "Hello, world! [..]"
 uvx oe-python-template-example serve           # serves webservice API
+uvx oe-python-template-example serve --port=4711 # serves webservice API on port 4711
 ```
 
-When serving the API, go to [http://127.0.0.1:8000/api/v1/hello-world](http://127.0.0.1:8000/api/v1/hello-world) to see the result.
-
-The API is versioned and provides interactive documentation at [http://127.0.0.1:8000/api/v1/docs](http://127.0.0.1:8000/api/v1/docs) resp. [http://127.0.0.1:8000/api/v2/docs](http://127.0.0.1:8000/api/v2/docs)
-
-
-```shell
+Notes:
+* The API is versioned, mounted at ```/api/v1``` resp. ```/api/v2```
+* While serving the webservice API go to [http://127.0.0.1:8000/api/v1/hello-world](http://127.0.0.1:8000/api/v1/hello-world) to see the respons of the ```hello-world``` operation.
+* Interactive documentation is provided at [http://127.0.0.1:8000/api/docs](http://127.0.0.1:8000/api/docs)
 
-When running the webservice API, goto http://127.0.0.1:8000/api/v1/docs
 
 The CLI provides extensive help:
 

oe_python_template_example-0.1.1/VERSION

@@ -0,0 +1 @@
+0.1.1

{oe_python_template_example-0.1.0 → oe_python_template_example-0.1.1}/_readme_main.md

@@ -76,16 +76,14 @@ Executing the command line interface (CLI) in an isolated Python environment is
 ```shell
 uvx oe-python-template-example hello-world     # prints "Hello, world! [..]"
 uvx oe-python-template-example serve           # serves webservice API
+uvx oe-python-template-example serve --port=4711 # serves webservice API on port 4711
 ```
 
-When serving the API, go to [http://127.0.0.1:8000/api/v1/hello-world](http://127.0.0.1:8000/api/v1/hello-world) to see the result.
-
-The API is versioned and provides interactive documentation at [http://127.0.0.1:8000/api/v1/docs](http://127.0.0.1:8000/api/v1/docs) resp. [http://127.0.0.1:8000/api/v2/docs](http://127.0.0.1:8000/api/v2/docs)
-
-
-```shell
+Notes:
+* The API is versioned, mounted at ```/api/v1``` resp. ```/api/v2```
+* While serving the webservice API go to [http://127.0.0.1:8000/api/v1/hello-world](http://127.0.0.1:8000/api/v1/hello-world) to see the respons of the ```hello-world``` operation.
+* Interactive documentation is provided at [http://127.0.0.1:8000/api/docs](http://127.0.0.1:8000/api/docs)
 
-When running the webservice API, goto http://127.0.0.1:8000/api/v1/docs
 
 The CLI provides extensive help:
 

{oe_python_template_example-0.1.0 → oe_python_template_example-0.1.1}/docs/source/conf.py

@@ -26,7 +26,7 @@ extensions = [
 project = "oe-python-template-example"
 author = "Helmut Hoffer von Ankershoffen"
 copyright = f" (c) 2025-{datetime.now(UTC).year}, {author}"  # noqa: A001
-version = "0.1.0"
+version = "0.1.1"
 release = version
 github_username = "helmut-hoffer-von-ankershoffen"
 github_repository = "oe-python-template-example"

{oe_python_template_example-0.1.0 → oe_python_template_example-0.1.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "oe-python-template-example"
-version = "0.1.0"
+version = "0.1.1"
 description = "🧠 Example project scaffolded and kept up to date with OE Python Template (oe-python-template)."
 readme = "README.md"
 authors = [
@@ -245,7 +245,7 @@ source = ["src/"]
 
 
 [tool.bumpversion]
-current_version = "0.1.0"
+current_version = "0.1.1"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"

{oe_python_template_example-0.1.0 → oe_python_template_example-0.1.1}/sonar-project.properties

@@ -1,6 +1,6 @@
 sonar.projectKey=helmut-hoffer-von-ankershoffen_oe-python-template-example
 sonar.organization=helmut-hoffer-von-ankershoffen
-sonar.projectVersion=0.1.0
+sonar.projectVersion=0.1.1
 sonar.projectDescription=🧠 Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
 sonar.links.homepage=https://oe-python-template-example.readthedocs.io/en/latest/
 sonar.links.scm=https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example

{oe_python_template_example-0.1.0 → oe_python_template_example-0.1.1}/src/oe_python_template_example/api.py

@@ -8,6 +8,7 @@ This module provides a webservice API with several endpoints:
 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
@@ -18,6 +19,8 @@ from pydantic import BaseModel, Field
 from oe_python_template_example import Service
 
 HELLO_WORLD_EXAMPLE = "Hello, world!"
+UVICORN_HOST = os.environ.get("UVICORN_HOST", "127.0.0.1")
+UVICORN_PORT = os.environ.get("UVICORN_PORT", "8000")
 
 
 def get_service() -> Generator[Service, None, None]:
@@ -47,12 +50,18 @@ api = FastAPI(
         {
             "name": "v1",
             "description": "API version 1, check link on the right",
-            "externalDocs": {"description": "sub-docs", "url": "/api/v1/docs"},
+            "externalDocs": {
+                "description": "sub-docs",
+                "url": f"http://{UVICORN_HOST}:{UVICORN_PORT}/api/v1/docs",
+            },
         },
         {
             "name": "v2",
             "description": "API version 2, check link on the right",
-            "externalDocs": {"description": "sub-docs", "url": "/api/v2/docs"},
+            "externalDocs": {
+                "description": "sub-docs",
+                "url": f"http://{UVICORN_HOST}:{UVICORN_PORT}/api/v2/docs",
+            },
         },
     ],
 )

{oe_python_template_example-0.1.0 → oe_python_template_example-0.1.1}/src/oe_python_template_example/cli.py

@@ -1,5 +1,6 @@
 """CLI (Command Line Interface) of OE Python Template Example."""
 
+import os
 from enum import StrEnum
 from typing import Annotated
 
@@ -49,6 +50,8 @@ def serve(
 ) -> None:
     """Start the API server."""
     console.print(f"Starting API server at http://{host}:{port}")
+    os.environ["UVICORN_HOST"] = host
+    os.environ["UVICORN_PORT"] = str(port)
     uvicorn.run(
         "oe_python_template_example.api:api",
         host=host,

{oe_python_template_example-0.1.0 → oe_python_template_example-0.1.1}/uv.lock

@@ -2075,7 +2075,7 @@ wheels = [
 
 [[package]]
 name = "oe-python-template-example"
-version = "0.1.0"
+version = "0.1.1"
 source = { editable = "." }
 dependencies = [
     { name = "fastapi", extra = ["all", "standard"] },

oe_python_template_example-0.1.0/VERSION

@@ -1 +0,0 @@
-0.1.0