oe-python-template 0.13.4__py3-none-any.whl → 0.13.6__py3-none-any.whl

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/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
 

{oe_python_template-0.13.4.dist-info → oe_python_template-0.13.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template
-Version: 0.13.4
+Version: 0.13.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/
@@ -438,13 +438,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 helmuthva/oe-python-template-slim --help
+docker run helmuthva/oe-python-template-slim hello world
+```
+
+You can pass environment variables as parameters:
 
 ```shell
-docker run --env THE_VAR=MY_VALUE helmuthva/oe-python-template hello echo "Lorem Ipsum"
+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
 ```
 
-Or use docker compose
+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 +493,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.dist-info → oe_python_template-0.13.6.dist-info}/RECORD

@@ -1,6 +1,6 @@
 oe_python_template/__init__.py,sha256=_Z3Xb-x95UODU66avOiwROVaouk_s0ZNB25KFnPoS40,226
 oe_python_template/api.py,sha256=Hcpj4UYFrZBaE-O8Iwb7poGCCtlMIqrmNiFqJSKElqI,2190
-oe_python_template/cli.py,sha256=XI0NSVLQtOAlhlZa8Znizycc3fu6OHl8xI7rJPlheeQ,1612
+oe_python_template/cli.py,sha256=371khUxULDDmYkwf05MXNrgzpIoSgGY9CWp_DCICdxQ,1677
 oe_python_template/constants.py,sha256=tIWRWxG7Ob-MwH8ucPplOMO3mCgXPo97acRjydpHiyg,330
 oe_python_template/hello/__init__.py,sha256=F7aJ_uhTPPnFLT_4GjI2GzjAmKrUhfe4KxqzrljuCVo,485
 oe_python_template/hello/_api.py,sha256=hWWlEDUfFY1se2ZzhqGMfPyD3FPwuA-YzxG9Q9z4F2o,2294
@@ -22,7 +22,7 @@ oe_python_template/utils/_cli.py,sha256=J_mFtXZ1gGeovGrE5i3wlokTOBfiTTKEz5magiRP
 oe_python_template/utils/_console.py,sha256=u0-utcdRmVu4rabrYUyNOx8yPxLhxB3E92m22kSCwPQ,293
 oe_python_template/utils/_constants.py,sha256=FRe5ZNaBwpBPwOHZVWYOlI-ijamfzdBVr8gl7gHMGT0,2932
 oe_python_template/utils/_di.py,sha256=KdjiD4xZ_QSfbddkKWwsPJmG5YrIg6dzuBrlsd-FhxA,2189
-oe_python_template/utils/_gui.py,sha256=RrvhaIi62X0E_lYou5GdB6LpQcCta2MeSvOKemh6ua4,5460
+oe_python_template/utils/_gui.py,sha256=PmMTSmUOxbf6pmYCIgKrK5wNheh35aGd90I12y3L7Uc,5720
 oe_python_template/utils/_health.py,sha256=35QOWe2r5InrEpGtuVMym9dI5aRHS0HWf4BHBRAUIj0,4102
 oe_python_template/utils/_log.py,sha256=ZW4gs540SdjVK-2KeheLfDY15d_3xpO5FyGn7wTXyaM,3592
 oe_python_template/utils/_logfire.py,sha256=wZYNVowQx7kh3XJoJ59FjUKdrta7tp6cXOJRUT6lDU8,2128
@@ -33,8 +33,8 @@ oe_python_template/utils/_service.py,sha256=atHAejvBucKXjzhsMSdOBBFa7rRD74zcV70P
 oe_python_template/utils/_settings.py,sha256=owFoaHEzJnVD3EVyOWF4rfIY7g6eLnU6rN0m4VHhCbA,2464
 oe_python_template/utils/boot.py,sha256=Qgq1sjT8d3fcfibnMyx5CVUJ_KKXgFI3ozZUIJbhh4I,2921
 oe_python_template/utils/.vendored/bottle.py,sha256=kZAZmh3nRzCUf-9IKGpv0yqlMciZMA_DNaaMDdcQmt0,175437
-oe_python_template-0.13.4.dist-info/METADATA,sha256=HsfFAo2Zi4OsqoYuYGjjdFurTG1iZSd98_Q1f4CCWcw,33529
-oe_python_template-0.13.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-oe_python_template-0.13.4.dist-info/entry_points.txt,sha256=IroSSWhLGxus9rxcashkYQda39TTvf7LbUMYtOKXUBE,66
-oe_python_template-0.13.4.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
-oe_python_template-0.13.4.dist-info/RECORD,,
+oe_python_template-0.13.6.dist-info/METADATA,sha256=ehTfNQ73ovAfs8Aqdf4NoMuKlBkXaOtyE0Y4RKgzFgM,33856
+oe_python_template-0.13.6.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+oe_python_template-0.13.6.dist-info/entry_points.txt,sha256=IroSSWhLGxus9rxcashkYQda39TTvf7LbUMYtOKXUBE,66
+oe_python_template-0.13.6.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
+oe_python_template-0.13.6.dist-info/RECORD,,