oe-python-template 0.13.4__tar.gz → 0.13.7__tar.gz

{oe_python_template-0.13.4 → oe_python_template-0.13.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template
-Version: 0.13.4
+Version: 0.13.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/
@@ -303,15 +303,12 @@ The following examples run from source - clone this repository using
 ```python
 """Example script demonstrating the usage of the service provided by OE Python Template."""
 
-from dotenv import load_dotenv
 from rich.console import Console
 
 from oe_python_template.hello import Service
 
 console = Console()
 
-load_dotenv()
-
 message = Service.get_hello_world()
 console.print(f"[blue]{message}[/blue]")
 ```
@@ -438,13 +435,22 @@ docker run helmuthva/oe-python-template system openapi --output-format=json
 docker run helmuthva/oe-python-template system serve
 ```
 
-Execute command:
+The default Docker image includes all extras. Additionally a slim image is provided, with no extras. Run as follows
 
 ```shell
-docker run --env THE_VAR=MY_VALUE helmuthva/oe-python-template hello echo "Lorem Ipsum"
+docker run helmuthva/oe-python-template-slim --help
+docker run helmuthva/oe-python-template-slim hello world
 ```
 
-Or use docker compose
+You can pass environment variables as parameters:
+
+```shell
+docker run --env OE_PYTHON_TEMPLATE_HELLO_LANGUAGE=de_DE helmuthva/oe-python-template hello world
+docker run --env OE_PYTHON_TEMPLATE_HELLO_LANGUAGE=en_US helmuthva/oe-python-template hello world
+```
+
+A docker compose stack is provided. Clone this repository using
+`git clone git@github.com:helmut-hoffer-von-ankershoffen/oe-python-template.git` and enter the repository folder.
 
 The .env is passed through from the host to the Docker container.
 
@@ -484,15 +490,6 @@ echo "Shutting down the API container ..."
 docker compose down
 ```
 
-#### Slim
-
-The default Docker image includes all extras. Additionally a slim image is provided, with no extras. Run as follows
-
-```shell
-docker compose run --remove-orphans oe-python-template-slim --help
-```
-
-
 * See the [reference documentation of the API](https://oe-python-template.readthedocs.io/en/latest/api_reference_v1.html) for detailed documentation of all API operations and parameters.
 
 

{oe_python_template-0.13.4 → oe_python_template-0.13.7}/README.md

@@ -229,15 +229,12 @@ The following examples run from source - clone this repository using
 ```python
 """Example script demonstrating the usage of the service provided by OE Python Template."""
 
-from dotenv import load_dotenv
 from rich.console import Console
 
 from oe_python_template.hello import Service
 
 console = Console()
 
-load_dotenv()
-
 message = Service.get_hello_world()
 console.print(f"[blue]{message}[/blue]")
 ```
@@ -364,13 +361,22 @@ docker run helmuthva/oe-python-template system openapi --output-format=json
 docker run helmuthva/oe-python-template system serve
 ```
 
-Execute command:
+The default Docker image includes all extras. Additionally a slim image is provided, with no extras. Run as follows
 
 ```shell
-docker run --env THE_VAR=MY_VALUE helmuthva/oe-python-template hello echo "Lorem Ipsum"
+docker run helmuthva/oe-python-template-slim --help
+docker run helmuthva/oe-python-template-slim hello world
 ```
 
-Or use docker compose
+You can pass environment variables as parameters:
+
+```shell
+docker run --env OE_PYTHON_TEMPLATE_HELLO_LANGUAGE=de_DE helmuthva/oe-python-template hello world
+docker run --env OE_PYTHON_TEMPLATE_HELLO_LANGUAGE=en_US helmuthva/oe-python-template hello world
+```
+
+A docker compose stack is provided. Clone this repository using
+`git clone git@github.com:helmut-hoffer-von-ankershoffen/oe-python-template.git` and enter the repository folder.
 
 The .env is passed through from the host to the Docker container.
 
@@ -410,15 +416,6 @@ echo "Shutting down the API container ..."
 docker compose down
 ```
 
-#### Slim
-
-The default Docker image includes all extras. Additionally a slim image is provided, with no extras. Run as follows
-
-```shell
-docker compose run --remove-orphans oe-python-template-slim --help
-```
-
-
 * See the [reference documentation of the API](https://oe-python-template.readthedocs.io/en/latest/api_reference_v1.html) for detailed documentation of all API operations and parameters.
 
 

{oe_python_template-0.13.4 → oe_python_template-0.13.7}/pyproject.toml

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

{oe_python_template-0.13.4 → oe_python_template-0.13.7}/src/oe_python_template/cli.py

@@ -6,7 +6,7 @@ from importlib.util import find_spec
 import typer
 
 from .constants import MODULES_TO_INSTRUMENT
-from .utils import __version__, boot, console, get_logger, prepare_cli
+from .utils import __is_running_in_container__, __version__, boot, console, get_logger, prepare_cli
 
 boot(MODULES_TO_INSTRUMENT)
 logger = get_logger(__name__)
@@ -15,7 +15,7 @@ cli = typer.Typer(help="Command Line Interface of OE Python Template")
 prepare_cli(cli, f"🧠 OE Python Template v{__version__} - built with love in Berlin 🐻")
 
 
-if find_spec("nicegui") and find_spec("webview"):
+if find_spec("nicegui") and find_spec("webview") and not __is_running_in_container__:
 
     @cli.command()
     def gui() -> None:

{oe_python_template-0.13.4 → oe_python_template-0.13.7}/src/oe_python_template/utils/_gui.py

@@ -6,7 +6,7 @@ from types import EllipsisType
 from nicegui import app, events, ui
 from nicegui import native as native_app
 
-from ._constants import __project_name__
+from ._constants import __is_running_in_container__, __project_name__
 from ._di import locate_subclasses
 from ._log import get_logger
 
@@ -55,8 +55,12 @@ def gui_run(  # noqa: PLR0913, PLR0917
         with_api: Whether to mount the API.
 
     Raises:
-        ValueError: If with_notebook is True but notebook_path is None.
+        ValueError: If with_notebook is True but notebook_path is None,
+            or trying to run native within container.
     """
+    if __is_running_in_container__ and native:
+        message = "Native GUI cannot be run in a container. Please run with uvx or in browser."
+        raise ValueError(message)
     if with_api:
         from ..api import api  # noqa: PLC0415, TID252