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

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

@@ -17,6 +17,10 @@ env/
 .secrets.json
 .act-env-secret
 
+# More secrets
+.ssh
+.aws
+
 # Python virtual environment
 venv/
 .venv/
@@ -69,6 +73,7 @@ tmp/
 # Node temps
 node_modules/
 
+
 # AI workflow
 .fixme
 
@@ -80,4 +85,5 @@ node_modules/
 .vercel
 
 
-# Application specific
+
+# Application specific

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template-example
-Version: 0.4.1
+Version: 0.4.3
 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
@@ -59,15 +60,15 @@ Requires-Dist: opentelemetry-instrumentation-tornado>=0.53b0
 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.8.1
-Requires-Dist: pydantic>=2.11.3
-Requires-Dist: sentry-sdk>=2.25.1
+Requires-Dist: pydantic-settings>=2.9.1
+Requires-Dist: sentry-sdk>=2.26.1
 Requires-Dist: typer>=0.15.1
 Requires-Dist: uptime>=3.0.1
 Provides-Extra: examples
 Requires-Dist: jinja2>=3.1.6; extra == 'examples'
 Requires-Dist: jupyter>=1.1.1; extra == 'examples'
-Requires-Dist: marimo>=0.12.8; 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
 
@@ -151,13 +152,15 @@ Projects generated with this template come with a comprehensive development tool
 17. Changelog and release notes generated with [git-cliff](https://git-cliff.org/)
 18. Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation for the library, CLI, and API
 19. Documentation published to [Read The Docs](https://readthedocs.org/) including generation of PDF and single page HTML versions
-20. Interactive OpenAPI specification with [Swagger](https://swagger.io/)
-21. Python package published to [PyPI](https://pypi.org/)
-22. Docker images published to [Docker.io](https://hub.docker.com/) and [GitHub Container Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry) with [artifact attestations](https://docs.github.com/en/actions/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-to-establish-provenance-for-builds)
-23. One-click development environments with [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) and [GitHub Codespaces](https://github.com/features/codespaces)
-24. Settings for use with [VSCode](https://code.visualstudio.com/)
-25. Settings and custom instructions for use with [GitHub Copilot](https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
-26. API deployed as serverless function to [Vercel](https://vercel.com/) (optional)
+20. Documentation including dynamic badges, setup instructions, contribution guide and security policy
+21. Interactive OpenAPI specification with [Swagger](https://swagger.io/)
+22. Python package published to [PyPI](https://pypi.org/)
+23. Multi-stage build of fat and slim (no-extras) Docker images, app running nonroot
+24. Mult-arch Docker images published to [Docker.io](https://hub.docker.com/) and [GitHub Container Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry) with [artifact attestations](https://docs.github.com/en/actions/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-to-establish-provenance-for-builds)
+25. One-click development environments with [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) and [GitHub Codespaces](https://github.com/features/codespaces)
+26. Settings for use with [VSCode](https://code.visualstudio.com/)
+27. Settings and custom instructions for use with [GitHub Copilot](https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
+28. API deployed as serverless function to [Vercel](https://vercel.com/) (optional)
 
 ### Application Features
 
@@ -165,17 +168,20 @@ Beyond development tooling, projects generated with this template include the co
 
 1. Usable as library with "Hello" module exposing a simple service that can say "Hello, world!" and echo utterances.
 2. Command-line interface (CLI) with [Typer](https://typer.tiangolo.com/)
-3. Versioned webservice API with [FastAPI](https://fastapi.tiangolo.com/)
-4. [Interactive Jupyter notebook](https://jupyter.org/) and [reactive Marimo notebook](https://marimo.io/)
-5. Simple Web UI with [Streamlit](https://streamlit.io/)
-6. Configuration to run the CLI and API in a Docker container including setup for [Docker Compose](https://docs.docker.com/get-started/docker-concepts/the-basics/what-is-docker-compose/)
+2. Versioned webservice API with [FastAPI](https://fastapi.tiangolo.com/)
+3. Comfortable command-line interface (CLI) with
+   [Typer](https://typer.tiangolo.com/)
+4. Cross-platform Graphical User Interface (GUI) with
+   [NiceGUI](https://nicegui.io/) running in native window
+5. [Interactive Jupyter notebook](https://jupyter.org/) and [reactive Marimo notebook](https://marimo.io/)
+6. Simple Web UI with [Streamlit](https://streamlit.io/)
 7. Validation and settings management with [pydantic](https://docs.pydantic.dev/)
-8. Info command enabling to inspect the runtime, compiled settings, and further info provided dynamically by modules
-9. Health endpoint exposing system health dynamically aggregated from all modules and dependencies
-10. Flexible logging and instrumentation, including support for [Sentry](https://sentry.io/) and [Logfire](https://logfire.dev/) 
-11. Hello service demonstrates use of custom real time metrics collected via Logfire
-12. Modular architecture including auto-registration of services, CLI commands and API routes exposed by modules
-13. Documentation including dynamic badges, setup instructions, contribution guide and security policy
+8. Flexible logging and instrumentation, including support for [Sentry](https://sentry.io/) and [Logfire](https://logfire.dev/) 
+9. Modular architecture including auto-registration of services, CLI commands, API routes and GUI pages exposed by domain modules
+10. System module providing aggregate health and info to the runtime, compiled settings, and further info provided by domain modules
+11. Health and Info available via command, webservice API (info passsword protected) and GUI
+12. Hello service demonstrates use of custom real time metrics collected via Logfire
+13. Configuration to run the CLI and API in a Docker container including setup for [Docker Compose](https://docs.docker.com/get-started/docker-concepts/the-basics/what-is-docker-compose/)
 
 Explore [here](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example) for what's generated out of the box.
 
@@ -242,9 +248,13 @@ pip install oe-python-template-example        # add dependency to your project
 Executing the command line interface (CLI) in an isolated Python environment is just as easy:
 
 ```shell
-uvx oe-python-template-example hello-world       # prints "Hello, world! [..]"
-uvx oe-python-template-example serve             # serves web API
-uvx oe-python-template-example serve --port=4711 # serves web API on port 4711
+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
 ```
 
 Notes:
@@ -257,10 +267,11 @@ The CLI provides extensive help:
 
 ```shell
 uvx oe-python-template-example --help                # all CLI commands
-uvx oe-python-template-example hello-world --help    # help for specific command
-uvx oe-python-template-example echo --help
-uvx oe-python-template-example openapi --help
-uvx oe-python-template-example serve --help
+uvx oe-python-template-example hello world --help    # help for specific command
+uvx oe-python-template-example hello echo --help
+uvx oe-python-template-example gui --help
+uvx oe-python-template-example system serve --help
+uvx oe-python-template-example system openapi --help
 ```
 
 
@@ -388,6 +399,8 @@ uvx oe-python-template-example hello world
 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
@@ -472,6 +485,15 @@ 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.1 → oe_python_template_example-0.4.3}/README.md

@@ -78,13 +78,15 @@ Projects generated with this template come with a comprehensive development tool
 17. Changelog and release notes generated with [git-cliff](https://git-cliff.org/)
 18. Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation for the library, CLI, and API
 19. Documentation published to [Read The Docs](https://readthedocs.org/) including generation of PDF and single page HTML versions
-20. Interactive OpenAPI specification with [Swagger](https://swagger.io/)
-21. Python package published to [PyPI](https://pypi.org/)
-22. Docker images published to [Docker.io](https://hub.docker.com/) and [GitHub Container Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry) with [artifact attestations](https://docs.github.com/en/actions/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-to-establish-provenance-for-builds)
-23. One-click development environments with [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) and [GitHub Codespaces](https://github.com/features/codespaces)
-24. Settings for use with [VSCode](https://code.visualstudio.com/)
-25. Settings and custom instructions for use with [GitHub Copilot](https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
-26. API deployed as serverless function to [Vercel](https://vercel.com/) (optional)
+20. Documentation including dynamic badges, setup instructions, contribution guide and security policy
+21. Interactive OpenAPI specification with [Swagger](https://swagger.io/)
+22. Python package published to [PyPI](https://pypi.org/)
+23. Multi-stage build of fat and slim (no-extras) Docker images, app running nonroot
+24. Mult-arch Docker images published to [Docker.io](https://hub.docker.com/) and [GitHub Container Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry) with [artifact attestations](https://docs.github.com/en/actions/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-to-establish-provenance-for-builds)
+25. One-click development environments with [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) and [GitHub Codespaces](https://github.com/features/codespaces)
+26. Settings for use with [VSCode](https://code.visualstudio.com/)
+27. Settings and custom instructions for use with [GitHub Copilot](https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
+28. API deployed as serverless function to [Vercel](https://vercel.com/) (optional)
 
 ### Application Features
 
@@ -92,17 +94,20 @@ Beyond development tooling, projects generated with this template include the co
 
 1. Usable as library with "Hello" module exposing a simple service that can say "Hello, world!" and echo utterances.
 2. Command-line interface (CLI) with [Typer](https://typer.tiangolo.com/)
-3. Versioned webservice API with [FastAPI](https://fastapi.tiangolo.com/)
-4. [Interactive Jupyter notebook](https://jupyter.org/) and [reactive Marimo notebook](https://marimo.io/)
-5. Simple Web UI with [Streamlit](https://streamlit.io/)
-6. Configuration to run the CLI and API in a Docker container including setup for [Docker Compose](https://docs.docker.com/get-started/docker-concepts/the-basics/what-is-docker-compose/)
+2. Versioned webservice API with [FastAPI](https://fastapi.tiangolo.com/)
+3. Comfortable command-line interface (CLI) with
+   [Typer](https://typer.tiangolo.com/)
+4. Cross-platform Graphical User Interface (GUI) with
+   [NiceGUI](https://nicegui.io/) running in native window
+5. [Interactive Jupyter notebook](https://jupyter.org/) and [reactive Marimo notebook](https://marimo.io/)
+6. Simple Web UI with [Streamlit](https://streamlit.io/)
 7. Validation and settings management with [pydantic](https://docs.pydantic.dev/)
-8. Info command enabling to inspect the runtime, compiled settings, and further info provided dynamically by modules
-9. Health endpoint exposing system health dynamically aggregated from all modules and dependencies
-10. Flexible logging and instrumentation, including support for [Sentry](https://sentry.io/) and [Logfire](https://logfire.dev/) 
-11. Hello service demonstrates use of custom real time metrics collected via Logfire
-12. Modular architecture including auto-registration of services, CLI commands and API routes exposed by modules
-13. Documentation including dynamic badges, setup instructions, contribution guide and security policy
+8. Flexible logging and instrumentation, including support for [Sentry](https://sentry.io/) and [Logfire](https://logfire.dev/) 
+9. Modular architecture including auto-registration of services, CLI commands, API routes and GUI pages exposed by domain modules
+10. System module providing aggregate health and info to the runtime, compiled settings, and further info provided by domain modules
+11. Health and Info available via command, webservice API (info passsword protected) and GUI
+12. Hello service demonstrates use of custom real time metrics collected via Logfire
+13. Configuration to run the CLI and API in a Docker container including setup for [Docker Compose](https://docs.docker.com/get-started/docker-concepts/the-basics/what-is-docker-compose/)
 
 Explore [here](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example) for what's generated out of the box.
 
@@ -169,9 +174,13 @@ pip install oe-python-template-example        # add dependency to your project
 Executing the command line interface (CLI) in an isolated Python environment is just as easy:
 
 ```shell
-uvx oe-python-template-example hello-world       # prints "Hello, world! [..]"
-uvx oe-python-template-example serve             # serves web API
-uvx oe-python-template-example serve --port=4711 # serves web API on port 4711
+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
 ```
 
 Notes:
@@ -184,10 +193,11 @@ The CLI provides extensive help:
 
 ```shell
 uvx oe-python-template-example --help                # all CLI commands
-uvx oe-python-template-example hello-world --help    # help for specific command
-uvx oe-python-template-example echo --help
-uvx oe-python-template-example openapi --help
-uvx oe-python-template-example serve --help
+uvx oe-python-template-example hello world --help    # help for specific command
+uvx oe-python-template-example hello echo --help
+uvx oe-python-template-example gui --help
+uvx oe-python-template-example system serve --help
+uvx oe-python-template-example system openapi --help
 ```
 
 
@@ -315,6 +325,8 @@ uvx oe-python-template-example hello world
 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
@@ -399,6 +411,15 @@ 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.1 → oe_python_template_example-0.4.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "oe-python-template-example"
-version = "0.4.1"
+version = "0.4.3"
 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,50 +75,30 @@ dependencies = [
     "opentelemetry-instrumentation-urllib>=0.53b0",
     "opentelemetry-instrumentation-urllib3>=0.53b0",
     "psutil>=7.0.0",
-    "pydantic>=2.11.3",
-    "pydantic-settings>=2.8.1",
-    "sentry-sdk>=2.25.1",
+    "pydantic-settings>=2.9.1",
+    "sentry-sdk>=2.26.1",
     "typer>=0.15.1",
     "uptime>=3.0.1",
     # Custom
     # Nothing yet
 ]
 
-[project.scripts]
-oe-python-template-example = "oe_python_template_example.cli:cli"
-
-[project.urls]
-Homepage = "https://oe-python-template-example.readthedocs.io/en/latest/"
-Documentation = "https://oe-python-template-example.readthedocs.io/en/latest/"
-Source = "https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example"
-Changelog = "https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/releases"
-Issues = "https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/issues"
-
-[build-system]
-requires = ["hatchling==1.27.0"]
-build-backend = "hatchling.build"
-
-[tool.hatch.build]
-include = ["src/*"]
-
-[tool.hatch.build.targets.wheel]
-packages = ["src/oe_python_template_example"]
-
 [project.optional-dependencies]
 examples = [
     "streamlit>=1.44.1",
-    "marimo>=0.12.8",
+    "marimo>=0.13.0",
     "jupyter>=1.1.1",
     "jinja2>=3.1.6",
+    "matplotlib>=3.10.1",
 ]
 
 [dependency-groups]
 dev = [
     "autodoc-pydantic>=2.2.0",
-    "bump-my-version>=1.1.1",
+    "bump-my-version>=1.1.2",
     "cyclonedx-py>=1.0.1",
     "detect-secrets>=1.5.0",
-    "enum-tools>=0.12.0",
+    "enum-tools>=0.13.0",
     "furo>=2024.8.6",
     "git-cliff>=2.8.0",
     "matplotlib>=3.10.1",
@@ -133,10 +114,12 @@ dev = [
     "pytest-docker>=3.2.1",
     "pytest-env>=1.1.5",
     "pytest-regressions>=2.7.0",
+    "pytest-selenium>=4.1.0",
     "pytest-subprocess>=1.5.3",
     "pytest-timeout>=2.3.1",
+    "pytest-watcher>=0.4.3",
     "pytest-xdist[psutil]>=3.6.1",
-    "ruff>=0.11.5",
+    "ruff>=0.11.6",
     "sphinx>=8.2.3",
     "sphinx-autobuild>=2024.10.3",
     "sphinx-copybutton>=0.5.2",
@@ -153,18 +136,37 @@ dev = [
     "watchdog>=6.0.0",
 ]
 
+[project.scripts]
+oe-python-template-example = "oe_python_template_example.cli:cli"
+
+[project.urls]
+Homepage = "https://oe-python-template-example.readthedocs.io/en/latest/"
+Documentation = "https://oe-python-template-example.readthedocs.io/en/latest/"
+Source = "https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example"
+Changelog = "https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/releases"
+Issues = "https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/issues"
+
+[build-system]
+requires = ["hatchling==1.27.0"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build]
+include = ["src/*"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/oe_python_template_example"]
+
 [tool.uv]
 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"]
@@ -227,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
@@ -278,7 +281,7 @@ source = ["src/"]
 
 
 [tool.bumpversion]
-current_version = "0.4.1"
+current_version = "0.4.3"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"
@@ -316,6 +319,9 @@ filename = "sonar-project.properties"
 [[tool.bumpversion.files]]
 filename = "docs/source/conf.py"
 
+[[tool.bumpversion.files]]
+filename = "examples/notebook.py"
+
 [tool.git-cliff.remote.github]
 owner = "helmut-hoffer-von-ankershoffen"
 repo = "oe-python-template-example"

{oe_python_template_example-0.4.1 → oe_python_template_example-0.4.3}/src/oe_python_template_example/api.py

@@ -31,7 +31,7 @@ API_BASE_URL = __base__url__
 if not API_BASE_URL:
     API_BASE_URL = f"http://{UVICORN_HOST}:{UVICORN_PORT}"
 
-app = FastAPI(
+api = FastAPI(
     root_path="/api",
     title=TITLE,
     contact={
@@ -76,4 +76,4 @@ for router in locate_implementations(VersionedAPIRouter):
 
 # Mount all API versions to the main app
 for version in API_VERSIONS:
-    app.mount(f"/{version}", api_instances[version])
+    api.mount(f"/{version}", api_instances[version])

oe_python_template_example-0.4.3/src/oe_python_template_example/cli.py

@@ -0,0 +1,55 @@
+"""CLI (Command Line Interface) of OE Python Template Example."""
+
+import sys
+from importlib.util import find_spec
+
+import typer
+
+from .constants import MODULES_TO_INSTRUMENT
+from .utils import __version__, boot, console, get_logger, prepare_cli
+
+boot(MODULES_TO_INSTRUMENT)
+logger = get_logger(__name__)
+
+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"):
+
+    @cli.command()
+    def gui() -> None:
+        """Start graphical user interface (GUI) in native window."""
+        from .utils import gui_run  # noqa: PLC0415
+
+        gui_run(native=True, with_api=False, title="OE Python Template Example", icon="🧠")
+
+
+if find_spec("marimo"):
+    from typing import Annotated
+
+    import uvicorn
+
+    from .utils import create_marimo_app
+
+    @cli.command()
+    def notebook(
+        host: Annotated[str, typer.Option(help="Host to bind the server to")] = "127.0.0.1",
+        port: Annotated[int, typer.Option(help="Port to bind the server to")] = 8001,
+    ) -> None:
+        """Start notebook in web browser."""
+        console.print(f"Starting marimo notebook server at http://{host}:{port}")
+        uvicorn.run(
+            create_marimo_app(),
+            host=host,
+            port=port,
+        )
+
+
+if __name__ == "__main__":  # pragma: no cover
+    try:
+        cli()
+    except Exception as e:  # noqa: BLE001
+        logger.critical("Fatal error occurred: %s", e)
+        console.print(f"Fatal error occurred: {e}", style="error")
+        sys.exit(1)

oe_python_template_example-0.4.3/src/oe_python_template_example/constants.py

@@ -0,0 +1,13 @@
+"""Constants for the OE Python Template Example."""
+
+from pathlib import Path
+
+MODULES_TO_INSTRUMENT = ["oe_python_template_example.hello"]
+
+API_VERSIONS = {
+    "v1": "1.0.0",
+    "v2": "2.0.0",
+}
+
+NOTEBOOK_FOLDER = Path(__file__).parent.parent.parent / "examples"
+NOTEBOOK_APP = Path(__file__).parent.parent.parent / "examples" / "notebook.py"

{oe_python_template_example-0.4.1 → oe_python_template_example-0.4.3}/src/oe_python_template_example/hello/__init__.py

@@ -15,3 +15,14 @@ __all__ = [
     "api_v2",
     "cli",
 ]
+
+
+from importlib.util import find_spec
+
+# advertise PageBuuilder to enable auto-discovery
+if find_spec("nicegui"):
+    from ._gui import PageBuilder
+
+    __all__ += [
+        "PageBuilder",
+    ]

oe_python_template_example-0.4.3/src/oe_python_template_example/hello/_gui.py

@@ -0,0 +1,44 @@
+"""Homepage (index) of GUI."""
+
+from pathlib import Path
+
+from nicegui import ui
+
+from oe_python_template_example.utils import BasePageBuilder, GUILocalFilePicker
+
+from ._service import Service
+
+
+async def pick_file() -> None:
+    """Open a file picker dialog and show notifier when closed again."""
+    result = await GUILocalFilePicker(str(Path.cwd() / "examples"), multiple=True)
+    ui.notify(f"You chose {result}")
+
+
+class PageBuilder(BasePageBuilder):
+    @staticmethod
+    def register_pages() -> None:
+        @ui.page("/")
+        def page_index() -> None:
+            """Homepage of GUI."""
+            service = Service()
+
+            ui.button("Choose file", on_click=pick_file, icon="folder").mark("BUTTON_CHOOSE_FILE")
+
+            ui.button("Click me", on_click=lambda: ui.notify(service.get_hello_world()), icon="check").mark(
+                "BUTTON_CLICK_ME"
+            )
+
+            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.1 → oe_python_template_example-0.4.3}/src/oe_python_template_example/system/__init__.py

@@ -1,4 +1,4 @@
-"""Hello module."""
+"""System module."""
 
 from ._api import api_routers
 from ._cli import cli
@@ -12,6 +12,17 @@ __all__ = [
     "cli",
 ]
 
+
+from importlib.util import find_spec
+
+# advertise PageBuuilder to enable auto-discovery
+if find_spec("nicegui"):
+    from ._gui import PageBuilder
+
+    __all__ += [
+        "PageBuilder",
+    ]
+
 # Export all individual API routers so they are picked up by depdency injection (DI)
 for version, router in api_routers.items():
     router_name = f"api_{version}"