oe-python-template 0.4.1__tar.gz → 0.4.3__tar.gz

{oe_python_template-0.4.1 → oe_python_template-0.4.3}/.copier-answers.yml

@@ -1,4 +1,4 @@
-_commit: v0.4.0-1-gdfc1c47
+_commit: v0.4.2-1-gc84332a
 _src_path: .
 author_email: helmuthva@gmail.com
 author_github_username: helmut-hoffer-von-ankershoffen

{oe_python_template-0.4.1 → oe_python_template-0.4.3}/CHANGELOG.md

@@ -1,6 +1,20 @@
 [🧠 OE Python Template](https://oe-python-template.readthedocs.io/en/latest/)
 
-## [0.4.1](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.4.0..0.4.1) - 2025-03-13
+## [0.4.3](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.4.2..0.4.3) - 2025-03-13
+
+### Enh
+
+- *(versioned api)* Central docs entrypoint - ([24fda94](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/24fda9401e864ef66109e701b7f549398282c98b))
+
+
+## [0.4.2](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.4.1..v0.4.2) - 2025-03-13
+
+### 🐛 Bug Fixes
+
+- *(docs)* Hardcoded command - ([d98e6fd](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/d98e6fde86fff01083b52e806295343fb5b5d828))
+
+
+## [0.4.1](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.4.0..v0.4.1) - 2025-03-13
 
 ### 🐛 Bug Fixes
 

{oe_python_template-0.4.1 → oe_python_template-0.4.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template
-Version: 0.4.1
+Version: 0.4.3
 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/
@@ -172,16 +172,14 @@ Executing the command line interface (CLI) in an isolated Python environment is
 ```shell
 uvx oe-python-template hello-world     # prints "Hello, world! [..]"
 uvx oe-python-template serve           # serves webservice API
+uvx oe-python-template 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-0.4.1 → oe_python_template-0.4.3}/README.md

@@ -111,16 +111,14 @@ Executing the command line interface (CLI) in an isolated Python environment is
 ```shell
 uvx oe-python-template hello-world     # prints "Hello, world! [..]"
 uvx oe-python-template serve           # serves webservice API
+uvx oe-python-template 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-0.4.3/RELEASE_NOTES.md

@@ -0,0 +1,8 @@
+## [0.4.3](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.4.2..v0.4.3) - 2025-03-13
+
+### Enh
+
+- *(versioned api)* Central docs entrypoint - ([24fda94](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/24fda9401e864ef66109e701b7f549398282c98b))
+
+
+

oe_python_template-0.4.3/VERSION

@@ -0,0 +1 @@
+0.4.3

{oe_python_template-0.4.1 → oe_python_template-0.4.3}/_readme_main.md

@@ -76,16 +76,14 @@ Executing the command line interface (CLI) in an isolated Python environment is
 ```shell
 uvx oe-python-template hello-world     # prints "Hello, world! [..]"
 uvx oe-python-template serve           # serves webservice API
+uvx oe-python-template 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-0.4.1 → oe_python_template-0.4.3}/docs/source/conf.py

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

{oe_python_template-0.4.1 → oe_python_template-0.4.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "oe-python-template"
-version = "0.4.1"
+version = "0.4.3"
 description = "🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling."
 readme = "README.md"
 authors = [
@@ -245,7 +245,7 @@ source = ["src/"]
 
 
 [tool.bumpversion]
-current_version = "0.4.1"
+current_version = "0.4.3"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"

{oe_python_template-0.4.1 → oe_python_template-0.4.3}/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.4.1
+sonar.projectVersion=0.4.3
 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.4.1 → oe_python_template-0.4.3}/src/oe_python_template/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 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-0.4.1 → oe_python_template-0.4.3}/src/oe_python_template/cli.py

@@ -1,5 +1,6 @@
 """CLI (Command Line Interface) of OE Python Template."""
 
+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.api:api",
         host=host,

{oe_python_template-0.4.1 → oe_python_template-0.4.3}/template/_readme_main.md.jinja

@@ -76,16 +76,14 @@ Executing the command line interface (CLI) in an isolated Python environment is
 ```shell
 uvx {{ pypi_distribution_name}} hello-world     # prints "Hello, world! [..]"
 uvx {{ pypi_distribution_name}} serve           # serves webservice API
+uvx {{ pypi_distribution_name}} 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-0.4.1 → oe_python_template-0.4.3}/template/noxfile.py.jinja

@@ -64,16 +64,16 @@ def docs(session: nox.Session) -> None:
     Path("README.md").write_text(readme_content, encoding="utf-8")
     # Dump openapi schema to file
     with Path("docs/source/_static/openapi_v1.yaml").open("w", encoding="utf-8") as f:
-        session.run("oe-python-template", "openapi", "--api-version=v1", stdout=f, external=True)
+        session.run("{{ pypi_distribution_name }}", "openapi", "--api-version=v1", stdout=f, external=True)
     with Path("docs/source/_static/openapi_v1.json").open("w", encoding="utf-8") as f:
         session.run(
-            "oe-python-template", "openapi", "--api-version=v1", "--output-format=json", stdout=f, external=True
+            "{{ pypi_distribution_name }}", "openapi", "--api-version=v1", "--output-format=json", stdout=f, external=True
         )
     with Path("docs/source/_static/openapi_v2.yaml").open("w", encoding="utf-8") as f:
-        session.run("oe-python-template", "openapi", "--api-version=v2", stdout=f, external=True)
+        session.run("{{ pypi_distribution_name }}", "openapi", "--api-version=v2", stdout=f, external=True)
     with Path("docs/source/_static/openapi_v2.json").open("w", encoding="utf-8") as f:
         session.run(
-            "oe-python-template", "openapi", "--api-version=v2", "--output-format=json", stdout=f, external=True
+            "{{ pypi_distribution_name }}", "openapi", "--api-version=v2", "--output-format=json", stdout=f, external=True
         )
     # Build docs
     session.run("make", "-C", "docs", "clean", external=True)

{oe_python_template-0.4.1 → oe_python_template-0.4.3}/template/src/{{ project_name_snake_case }}/api.py.jinja

@@ -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 {{ project_name_snake_case }} 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]:
@@ -49,7 +52,7 @@ api = FastAPI(
             "description": "API version 1, check link on the right",
             'externalDocs': {
                 'description': 'sub-docs',
-                'url': '/api/v1/docs'
+                "url": f"http://{UVICORN_HOST}:{UVICORN_PORT}/api/v1/docs",
             }
         },
         {
@@ -57,7 +60,7 @@ api = FastAPI(
             "description": "API version 2, check link on the right",
             'externalDocs': {
                 'description': 'sub-docs',
-                'url': '/api/v2/docs'
+                "url": f"http://{UVICORN_HOST}:{UVICORN_PORT}/api/v2/docs",
             }
         },
     ]

{oe_python_template-0.4.1 → oe_python_template-0.4.3}/template/src/{{ project_name_snake_case }}/cli.py.jinja

@@ -3,6 +3,7 @@
 from enum import StrEnum
 from typing import Annotated
 
+import os
 import typer
 import uvicorn
 import yaml
@@ -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(
         "{{ project_name_snake_case }}.api:api",
         host=host,

{oe_python_template-0.4.1 → oe_python_template-0.4.3}/uv.lock

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

oe_python_template-0.4.1/RELEASE_NOTES.md

@@ -1,8 +0,0 @@
-## [0.4.1](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.4.0..v0.4.1) - 2025-03-13
-
-### 🐛 Bug Fixes
-
-- *(tests)* Test_cli_serve - ([ac1a02c](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/ac1a02c04f39c664d71ffa127af72635b5eadfa5))
-
-
-

oe_python_template-0.4.1/VERSION

@@ -1 +0,0 @@
-0.4.1