oe-python-template-example 0.4.3__py3-none-any.whl → 0.4.5__py3-none-any.whl

oe_python_template_example/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 Example")
 prepare_cli(cli, f"🧠 OE Python Template Example 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_example/utils/.vendored/bottle.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 """
 Bottle is a fast and simple micro-framework for small web applications. It
 offers request dispatching (Routes) with URL parameter support, templates,

oe_python_template_example/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_example-0.4.3.dist-info → oe_python_template_example-0.4.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template-example
-Version: 0.4.3
+Version: 0.4.5
 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/
@@ -376,11 +376,15 @@ uv run marimo edit examples/notebook.py --watch     # Edit on localhost:2718, op
 
 ... or edit interactively within VSCode
 
-Install the
-[Marimo extension for VSCode](https://marketplace.visualstudio.com/items?itemName=marimo-team.vscode-marimo)
+Install the [Marimo extension for VSCode](https://marketplace.visualstudio.com/items?itemName=marimo-team.vscode-marimo)
+
+Click on `examples/notebook.py` in VSCode and click on the caret next to the Run icon above the code (looks like a pencil) > "Start in marimo editor" (edit).
+
+... or without prior cloning of the repository
 
-Click on `examples/notebook.py` in VSCode and click on the caret next to the Run
-icon above the code (looks like a pencil) > "Start in marimo editor" (edit).
+```shell
+uvx marimo run https://raw.githubusercontent.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/refs/heads/main/examples/notebook.py
+```
 
 ## Command Line Interface (CLI)
 
@@ -439,13 +443,22 @@ docker run helmuthva/oe-python-template-example system openapi --output-format=j
 docker run helmuthva/oe-python-template-example 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-example hello echo "Lorem Ipsum"
+docker run helmuthva/oe-python-template-example-slim --help
+docker run helmuthva/oe-python-template-example-slim hello world
 ```
 
-Or use docker compose
+You can pass environment variables as parameters:
+
+```shell
+docker run --env OE_PYTHON_TEMPLATE_EXAMPLE_HELLO_LANGUAGE=de_DE helmuthva/oe-python-template-example hello world
+docker run --env OE_PYTHON_TEMPLATE_EXAMPLE_HELLO_LANGUAGE=en_US helmuthva/oe-python-template-example hello world
+```
+
+A docker compose stack is provided. Clone this repository using
+`git clone git@github.com:helmut-hoffer-von-ankershoffen/oe-python-template-example.git` and enter the repository folder.
 
 The .env is passed through from the host to the Docker container.
 
@@ -485,15 +498,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-example-slim --help
-```
-
-
 * See the [reference documentation of the API](https://oe-python-template-example.readthedocs.io/en/latest/api_reference_v1.html) for detailed documentation of all API operations and parameters.
 
 

{oe_python_template_example-0.4.3.dist-info → oe_python_template_example-0.4.5.dist-info}/RECORD

@@ -1,6 +1,6 @@
 oe_python_template_example/__init__.py,sha256=_Z3Xb-x95UODU66avOiwROVaouk_s0ZNB25KFnPoS40,226
 oe_python_template_example/api.py,sha256=gwUAW_pWUABFtAAiuIg3-X-dG25m1l0rqpnMqlaGEJo,2206
-oe_python_template_example/cli.py,sha256=fnE06WJFcks5N4LwWlgIDHICciKY1FM944aAdJM6Ju0,1644
+oe_python_template_example/cli.py,sha256=hZUPTuuUkIOpgTN6dP3nUh7gflxe6pdY2trruq3Eqhs,1709
 oe_python_template_example/constants.py,sha256=eRFVkR2qwafucpx5ppJSohr5wpSRm4yh1deLpOTep9A,346
 oe_python_template_example/hello/__init__.py,sha256=F7aJ_uhTPPnFLT_4GjI2GzjAmKrUhfe4KxqzrljuCVo,485
 oe_python_template_example/hello/_api.py,sha256=B4gCojmEkvh-ScKPz0rXW70r4gVvg7SX2dfbZpUd2vU,2302
@@ -22,7 +22,7 @@ oe_python_template_example/utils/_cli.py,sha256=J_mFtXZ1gGeovGrE5i3wlokTOBfiTTKE
 oe_python_template_example/utils/_console.py,sha256=u0-utcdRmVu4rabrYUyNOx8yPxLhxB3E92m22kSCwPQ,293
 oe_python_template_example/utils/_constants.py,sha256=FRe5ZNaBwpBPwOHZVWYOlI-ijamfzdBVr8gl7gHMGT0,2932
 oe_python_template_example/utils/_di.py,sha256=KdjiD4xZ_QSfbddkKWwsPJmG5YrIg6dzuBrlsd-FhxA,2189
-oe_python_template_example/utils/_gui.py,sha256=RrvhaIi62X0E_lYou5GdB6LpQcCta2MeSvOKemh6ua4,5460
+oe_python_template_example/utils/_gui.py,sha256=PmMTSmUOxbf6pmYCIgKrK5wNheh35aGd90I12y3L7Uc,5720
 oe_python_template_example/utils/_health.py,sha256=35QOWe2r5InrEpGtuVMym9dI5aRHS0HWf4BHBRAUIj0,4102
 oe_python_template_example/utils/_log.py,sha256=ZW4gs540SdjVK-2KeheLfDY15d_3xpO5FyGn7wTXyaM,3592
 oe_python_template_example/utils/_logfire.py,sha256=wZYNVowQx7kh3XJoJ59FjUKdrta7tp6cXOJRUT6lDU8,2128
@@ -32,9 +32,9 @@ oe_python_template_example/utils/_sentry.py,sha256=2sXrDSZSYoDEM87v7CakJ6eGBtcIh
 oe_python_template_example/utils/_service.py,sha256=atHAejvBucKXjzhsMSdOBBFa7rRD74zcV70Pp0pl0Tg,1038
 oe_python_template_example/utils/_settings.py,sha256=owFoaHEzJnVD3EVyOWF4rfIY7g6eLnU6rN0m4VHhCbA,2464
 oe_python_template_example/utils/boot.py,sha256=Qgq1sjT8d3fcfibnMyx5CVUJ_KKXgFI3ozZUIJbhh4I,2921
-oe_python_template_example/utils/.vendored/bottle.py,sha256=D9YkHqkgvKkknd3ZQ-tgflUF6F9Kr2_jpzhod5WqfAM,175461
-oe_python_template_example-0.4.3.dist-info/METADATA,sha256=d-7MUnXzb7WLnxp0YXs6GCxWD85_ziJjvkdba-H3tek,34643
-oe_python_template_example-0.4.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-oe_python_template_example-0.4.3.dist-info/entry_points.txt,sha256=S2eCPB45b1Wgj_GsDRFAN-e4h7dBA5UPxT8od98erDE,82
-oe_python_template_example-0.4.3.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
-oe_python_template_example-0.4.3.dist-info/RECORD,,
+oe_python_template_example/utils/.vendored/bottle.py,sha256=kZAZmh3nRzCUf-9IKGpv0yqlMciZMA_DNaaMDdcQmt0,175437
+oe_python_template_example-0.4.5.dist-info/METADATA,sha256=pMAf2hpHZvzhcWfCZI79Y4rtMcaEEspldfxDaZOl4H4,35216
+oe_python_template_example-0.4.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+oe_python_template_example-0.4.5.dist-info/entry_points.txt,sha256=S2eCPB45b1Wgj_GsDRFAN-e4h7dBA5UPxT8od98erDE,82
+oe_python_template_example-0.4.5.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
+oe_python_template_example-0.4.5.dist-info/RECORD,,