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

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

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

{oe_python_template_example-0.4.2 → 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.2
+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/
@@ -50,6 +50,7 @@ Classifier: Typing :: Typed
 Requires-Python: <4.0,>=3.11
 Requires-Dist: fastapi[all,standard]>=0.115.12
 Requires-Dist: logfire[system-metrics]>=3.13.1
+Requires-Dist: nicegui[native]>=2.15.0
 Requires-Dist: opentelemetry-instrumentation-fastapi>=0.53b0
 Requires-Dist: opentelemetry-instrumentation-httpx>=0.53b0
 Requires-Dist: opentelemetry-instrumentation-jinja2>=0.53b0
@@ -60,17 +61,14 @@ Requires-Dist: opentelemetry-instrumentation-urllib3>=0.53b0
 Requires-Dist: opentelemetry-instrumentation-urllib>=0.53b0
 Requires-Dist: psutil>=7.0.0
 Requires-Dist: pydantic-settings>=2.9.1
-Requires-Dist: pydantic>=2.11.3
 Requires-Dist: sentry-sdk>=2.26.1
 Requires-Dist: typer>=0.15.1
 Requires-Dist: uptime>=3.0.1
-Provides-Extra: app
-Requires-Dist: nicegui>=2.15.0; extra == 'app'
-Requires-Dist: pywebview>=5.4; extra == 'app'
 Provides-Extra: examples
 Requires-Dist: jinja2>=3.1.6; extra == 'examples'
 Requires-Dist: jupyter>=1.1.1; extra == 'examples'
 Requires-Dist: marimo>=0.13.0; extra == 'examples'
+Requires-Dist: matplotlib>=3.10.1; extra == 'examples'
 Requires-Dist: streamlit>=1.44.1; extra == 'examples'
 Description-Content-Type: text/markdown
 
@@ -253,6 +251,7 @@ Executing the command line interface (CLI) in an isolated Python environment is
 uvx oe-python-template-example hello world               # prints "Hello, world! [..]"
 uvx oe-python-template-example hello echo "Lorem Ipsum"  # echos "Lorem Ipsum"
 uvx oe-python-template-example gui                       # opens the graphical user interface (GUI)
+uvx --with "oe-python-template-example[examples]" oe-python-template-example gui  # opens the graphical user interface (GUI) with support for scientific computing
 uvx oe-python-template-example system serve              # serves web API
 uvx oe-python-template-example system serve --port=4711  # serves web API on port 4711
 uvx oe-python-template-example system openapi            # serves web API on port 4711
@@ -377,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)
 
@@ -401,6 +404,7 @@ uvx oe-python-template-example hello echo --help
 uvx oe-python-template-example hello echo "Lorem"
 uvx oe-python-template-example hello echo "Lorem" --json
 uvx oe-python-template-example gui
+uvx --with "oe-python-template-example[examples]" oe-python-template-example gui  # opens the graphical user interface (GUI) with support for scientific computing
 uvx oe-python-template-example system info
 uvx oe-python-template-example system health
 uvx oe-python-template-example system openapi
@@ -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.2 → oe_python_template_example-0.4.5}/README.md

@@ -177,6 +177,7 @@ Executing the command line interface (CLI) in an isolated Python environment is
 uvx oe-python-template-example hello world               # prints "Hello, world! [..]"
 uvx oe-python-template-example hello echo "Lorem Ipsum"  # echos "Lorem Ipsum"
 uvx oe-python-template-example gui                       # opens the graphical user interface (GUI)
+uvx --with "oe-python-template-example[examples]" oe-python-template-example gui  # opens the graphical user interface (GUI) with support for scientific computing
 uvx oe-python-template-example system serve              # serves web API
 uvx oe-python-template-example system serve --port=4711  # serves web API on port 4711
 uvx oe-python-template-example system openapi            # serves web API on port 4711
@@ -301,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)
 
@@ -325,6 +330,7 @@ uvx oe-python-template-example hello echo --help
 uvx oe-python-template-example hello echo "Lorem"
 uvx oe-python-template-example hello echo "Lorem" --json
 uvx oe-python-template-example gui
+uvx --with "oe-python-template-example[examples]" oe-python-template-example gui  # opens the graphical user interface (GUI) with support for scientific computing
 uvx oe-python-template-example system info
 uvx oe-python-template-example system health
 uvx oe-python-template-example system openapi
@@ -363,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.
 
@@ -409,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.2 → oe_python_template_example-0.4.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "oe-python-template-example"
-version = "0.4.2"
+version = "0.4.5"
 description = "🧠 Example project scaffolded and kept up to date with OE Python Template (oe-python-template)."
 readme = "README.md"
 authors = [
@@ -65,6 +65,7 @@ dependencies = [
     # From Template
     "fastapi[standard,all]>=0.115.12",
     "logfire[system-metrics]>=3.13.1",
+    "nicegui[native]>=2.15.0",
     "opentelemetry-instrumentation-fastapi>=0.53b0",
     "opentelemetry-instrumentation-httpx>=0.53b0",
     "opentelemetry-instrumentation-jinja2>=0.53b0",
@@ -74,7 +75,6 @@ dependencies = [
     "opentelemetry-instrumentation-urllib>=0.53b0",
     "opentelemetry-instrumentation-urllib3>=0.53b0",
     "psutil>=7.0.0",
-    "pydantic>=2.11.3",
     "pydantic-settings>=2.9.1",
     "sentry-sdk>=2.26.1",
     "typer>=0.15.1",
@@ -89,8 +89,8 @@ examples = [
     "marimo>=0.13.0",
     "jupyter>=1.1.1",
     "jinja2>=3.1.6",
+    "matplotlib>=3.10.1",
 ]
-app = ["nicegui>=2.15.0", "pywebview>=5.4"]
 
 [dependency-groups]
 dev = [
@@ -161,13 +161,12 @@ override-dependencies = [ # https://github.com/astral-sh/uv/issues/4422
     "rfc3987; sys_platform == 'never'", # GPLv3
 ]
 
-
 [tool.ruff]
 target-version = "py311"
 preview = true
 fix = true
 line-length = 120
-extend-exclude = [".fixme", "notebook.py", "template/*.py"]
+extend-exclude = [".fixme", "notebook.py", "template/*.py", "bottle.py"]
 
 [tool.ruff.lint]
 select = ["ALL"]
@@ -230,6 +229,7 @@ docstring-code-format = true
 convention = "google"
 
 [tool.mypy] # https://mypy.readthedocs.io/en/latest/config_file.html
+exclude = ["bottle.py"]
 junit_xml = "reports/mypy_junit.xml"
 plugins = "pydantic.mypy"
 strict = true
@@ -281,7 +281,7 @@ source = ["src/"]
 
 
 [tool.bumpversion]
-current_version = "0.4.2"
+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.2 → 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"):
+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.2 → oe_python_template_example-0.4.5}/src/oe_python_template_example/hello/_gui.py

@@ -2,7 +2,6 @@
 
 from pathlib import Path
 
-import numpy as np
 from nicegui import ui
 
 from oe_python_template_example.utils import BasePageBuilder, GUILocalFilePicker
@@ -30,11 +29,16 @@ class PageBuilder(BasePageBuilder):
                 "BUTTON_CLICK_ME"
             )
 
-            with ui.card().tight().mark("CARD_PLOT"):  # noqa: SIM117
-                with ui.matplotlib(figsize=(4, 3)).figure as fig:
-                    x = np.linspace(0.0, 5.0)
-                    y = np.cos(2 * np.pi * x) * np.exp(-x)
-                    ax = fig.gca()
-                    ax.plot(x, y, "-")
+            from importlib.util import find_spec  # noqa: PLC0415
+
+            if find_spec("matplotlib") and find_spec("numpy"):
+                import numpy as np  # noqa: PLC0415
+
+                with ui.card().tight().mark("CARD_PLOT"):  # noqa: SIM117
+                    with ui.matplotlib(figsize=(4, 3)).figure as fig:
+                        x = np.linspace(0.0, 5.0)
+                        y = np.cos(2 * np.pi * x) * np.exp(-x)
+                        ax = fig.gca()
+                        ax.plot(x, y, "-")
 
             ui.link("Info", "/info").mark("LINK_INFO")

{oe_python_template_example-0.4.2 → oe_python_template_example-0.4.5}/src/oe_python_template_example/system/_service.py

@@ -108,6 +108,7 @@ class Service(BaseService):
                     "version": platform.python_version(),
                     "compiler": platform.python_compiler(),
                     "implementation": platform.python_implementation(),
+                    "sys.path": sys.path,
                 },
                 "interpreter_path": sys.executable,
                 "command_line": " ".join(sys.argv),