oe-python-template-example 0.4.3__tar.gz → 0.4.5__tar.gz

{oe_python_template_example-0.4.3 → oe_python_template_example-0.4.5}/.gitignore

@@ -86,4 +86,4 @@ node_modules/
 
 
 
-# Application specific
+# Application specific

{oe_python_template_example-0.4.3 → oe_python_template_example-0.4.5}/PKG-INFO

@@ -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 → oe_python_template_example-0.4.5}/README.md

@@ -302,11 +302,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)
 
@@ -365,13 +369,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.
 
@@ -411,15 +424,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 → oe_python_template_example-0.4.5}/pyproject.toml

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

{oe_python_template_example-0.4.3 → oe_python_template_example-0.4.5}/src/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-0.4.3 → oe_python_template_example-0.4.5}/src/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-0.4.3 → oe_python_template_example-0.4.5}/src/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