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

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/cli.py

@@ -1,6 +1,7 @@
 """CLI (Command Line Interface) of OE Python Template Example."""
 
 import sys
+from importlib.util import find_spec
 
 import typer
 
@@ -10,9 +11,41 @@ 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 ")
+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()

oe_python_template_example/constants.py

@@ -1,7 +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",
 }
-MODULES_TO_INSTRUMENT = ["oe_python_template_example.hello"]
+
+NOTEBOOK_FOLDER = Path(__file__).parent.parent.parent / "examples"
+NOTEBOOK_APP = Path(__file__).parent.parent.parent / "examples" / "notebook.py"

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

oe_python_template_example/system/_cli.py

@@ -3,6 +3,7 @@
 import json
 import os
 from enum import StrEnum
+from importlib.util import find_spec
 from typing import Annotated
 
 import typer
@@ -81,29 +82,69 @@ def info(
             console.print(yaml.dump(info, width=80, default_flow_style=False), end="")
 
 
-@cli.command()
-def serve(
-    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")] = 8000,
-    watch: Annotated[bool, typer.Option(help="Enable auto-reload")] = True,
-) -> None:
-    """Start the webservice API server.
-
-    Args:
-        host (str): Host to bind the server to.
-        port (int): Port to bind the server to.
-        watch (bool): Enable auto-reload.
-    """
-    console.print(f"Starting API server at http://{host}:{port}")
-    # using environ to pass host/port to api.py to generate doc link
-    os.environ["UVICORN_HOST"] = host
-    os.environ["UVICORN_PORT"] = str(port)
-    uvicorn.run(
-        f"{__project_name__}.api:app",
-        host=host,
-        port=port,
-        reload=watch,
-    )
+if find_spec("nicegui"):
+    from ..utils import gui_run  # noqa: TID252
+
+    @cli.command()
+    def serve(  # noqa: PLR0913, PLR0917 # type: ignore
+        app: Annotated[bool, typer.Option(help="Enable web application")] = True,
+        api: Annotated[bool, typer.Option(help="Enable webservice API")] = True,
+        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")] = 8000,
+        watch: Annotated[bool, typer.Option(help="Enable auto-reload on changes of source code")] = True,
+        open_browser: Annotated[bool, typer.Option(help="Open app in browser after starting the server")] = False,
+    ) -> None:
+        """Start the web server, hosting the graphical web application and/or webservice API.
+
+        Args:
+            app (bool): Enable web application.
+            api (bool): Enable webservice API.
+            host (str): Host to bind the server to.
+            port (int): Port to bind the server to.
+            watch (bool): Enable auto-reload on changes of source code.
+            open_browser (bool): Open app in browser after starting the server.
+        """
+        if api and not app:
+            console.print(f"Starting webservice API server at http://{host}:{port}")
+            # using environ to pass host/port to api.py to generate doc link
+            os.environ["UVICORN_HOST"] = host
+            os.environ["UVICORN_PORT"] = str(port)
+            uvicorn.run(
+                f"{__project_name__}.api:api",
+                host=host,
+                port=port,
+                reload=watch,
+            )
+        elif app:
+            console.print(f"Starting web application server at http://{host}:{port}")
+            gui_run(native=False, host=host, port=port, with_api=api, show=open_browser)
+
+else:
+
+    @cli.command()
+    def serve(  # type: ignore
+        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")] = 8000,
+        watch: Annotated[bool, typer.Option(help="Enable auto-reload on changes of source code")] = True,
+    ) -> None:
+        """Start the web server, hosting the API.
+
+        Args:
+            api (bool): Enable webservice API.
+            host (str): Host to bind the server to.
+            port (int): Port to bind the server to.
+            watch (bool): Enable auto-reload on changes of source code.
+        """
+        console.print(f"Starting webservice API server at http://{host}:{port}")
+        # using environ to pass host/port to api.py to generate doc link
+        os.environ["UVICORN_HOST"] = host
+        os.environ["UVICORN_PORT"] = str(port)
+        uvicorn.run(
+            f"{__project_name__}.api:api",
+            host=host,
+            port=port,
+            reload=watch,
+        )
 
 
 @cli.command()

oe_python_template_example/system/_gui.py

@@ -0,0 +1,20 @@
+"""Homepage (index) of GUI."""
+
+from nicegui import ui
+
+from ..utils import BasePageBuilder, __project_name__, __version__  # noqa: TID252
+from ._service import Service
+
+
+class PageBuilder(BasePageBuilder):
+    @staticmethod
+    def register_pages() -> None:
+        @ui.page("/info")
+        def page_info() -> None:
+            """Homepage of GUI."""
+            ui.label(f"{__project_name__} v{__version__}").mark("LABEL_VERSION")
+            ui.json_editor({
+                "content": {"json": Service().info(True, True)},
+                "readOnly": True,
+            }).mark("JSON_EDITOR_INFO")
+            ui.link("Home", "/").mark("LINK_HOME")

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),