cuiman 0.1.2__tar.gz → 0.2.0__tar.gz

{cuiman-0.1.2 → cuiman-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cuiman
-Version: 0.1.2
+Version: 0.2.0
 Summary: Provides a client Python API, GUI, and CLI for servers compliant with OGC API - Processes
 Project-URL: Documentation, https://eo-tools.github.io/eozilla
 Project-URL: Repository, https://github.com/eo-tools/eozilla
@@ -27,17 +27,13 @@ Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Software Development
 Classifier: Typing :: Typed
 Requires-Python: >=3.10
-Requires-Dist: click
-Requires-Dist: gavicore>=0.1.2
+Requires-Dist: gavicore>=0.2.0
 Requires-Dist: httpx
-Requires-Dist: ipyfilechooser
-Requires-Dist: ipyleaflet
-Requires-Dist: panel
 Requires-Dist: pydantic
 Requires-Dist: pydantic-settings
 Requires-Dist: pyyaml
-Requires-Dist: remotestate<1,>=0.3.1
-Requires-Dist: typer
+Requires-Dist: remotestate<1,>=0.3.4
+Requires-Dist: typer<1,>=0.26.0
 Requires-Dist: uri-template
 Description-Content-Type: text/markdown
 

{cuiman-0.1.2 → cuiman-0.2.0}/cuiman/__init__.py

@@ -8,6 +8,7 @@ from .api.async_client import AsyncClient
 from .api.client import Client
 from .api.config import ClientConfig
 from .api.exceptions import ClientError
+from .api.jobs import JobMonitor, JobOptions
 
 __version__ = version("cuiman")
 
@@ -16,5 +17,7 @@ __all__ = [
     "Client",
     "ClientConfig",
     "ClientError",
+    "JobMonitor",
+    "JobOptions",
     "__version__",
 ]

{cuiman-0.1.2 → cuiman-0.2.0}/cuiman/api/__init__.py

@@ -6,10 +6,13 @@ from .async_client import AsyncClient
 from .client import Client
 from .config import ClientConfig
 from .exceptions import ClientError
+from .jobs import JobMonitor, JobOptions
 
 __all__ = [
     "AsyncClient",
     "Client",
     "ClientConfig",
     "ClientError",
+    "JobMonitor",
+    "JobOptions",
 ]

{cuiman-0.1.2 → cuiman-0.2.0}/cuiman/api/async_client.py

@@ -1,6 +1,6 @@
 # generated by gen_client.py:
 #   filename:  async_client.py:
-#   timestamp: 2026-07-08T13:06:46.295496
+#   timestamp: 2026-07-15T17:16:03.217600
 
 
 from typing import Any, Optional
@@ -18,13 +18,14 @@ from gavicore.models import (
 )
 
 from .async_client_mixin import AsyncClientMixin
+from .client_app_mixin import ClientAppMixin
 from .config import ClientConfig
 from .ishell import has_ishell as _  # noqa F401
 from .transport import AsyncTransport, TransportArgs
 from .transport.httpx import HttpxTransport
 
 
-class AsyncClient(AsyncClientMixin):
+class AsyncClient(ClientAppMixin, AsyncClientMixin):
     """
     The client API for the web service (asynchronous mode).
 
@@ -56,8 +57,9 @@ class AsyncClient(AsyncClientMixin):
             raise ValueError("Required setting 'api_url' not configured")
         self._transport = (
             HttpxTransport(
-                api_url=self._config.api_url,
+                api_url=f"{self._config.api_url.rstrip('/')}/",
                 headers=self._config.auth_headers,
+                return_type_map=self._config.return_type_map,
                 async_token_refresher=self._config._make_async_token_refresher(),
                 debug=_debug,
             )

{cuiman-0.1.2 → cuiman-0.2.0}/cuiman/api/client.py

@@ -1,6 +1,6 @@
 # generated by gen_client.py:
 #   filename:  client.py:
-#   timestamp: 2026-07-08T13:06:43.275607
+#   timestamp: 2026-07-15T17:16:02.527617
 
 
 from typing import Any, Optional
@@ -17,6 +17,7 @@ from gavicore.models import (
     ProcessRequest,
 )
 
+from .client_app_mixin import ClientAppMixin
 from .client_mixin import ClientMixin
 from .config import ClientConfig
 from .ishell import has_ishell as _  # noqa F401
@@ -24,7 +25,7 @@ from .transport import Transport, TransportArgs
 from .transport.httpx import HttpxTransport
 
 
-class Client(ClientMixin):
+class Client(ClientAppMixin, ClientMixin):
     """
     The client API for the web service (synchronous mode).
 
@@ -56,8 +57,9 @@ class Client(ClientMixin):
             raise ValueError("Required setting 'api_url' not configured")
         self._transport = (
             HttpxTransport(
-                api_url=self._config.api_url,
+                api_url=f"{self._config.api_url.rstrip('/')}/",
                 headers=self._config.auth_headers,
+                return_type_map=self._config.return_type_map,
                 token_refresher=self._config._maybe_make_token_refresher(),
                 debug=_debug,
             )

cuiman-0.2.0/cuiman/api/client_app_mixin.py

@@ -0,0 +1,110 @@
+#  Copyright (c) 2025-2026 by the Eozilla team and contributors
+#  Permissions are hereby granted under the terms of the Apache 2.0 License:
+#  https://opensource.org/license/apache-2-0.
+
+from abc import ABC, abstractmethod
+from typing import TYPE_CHECKING, Literal
+
+from cuiman.api.ishell import has_ishell
+from cuiman.app.serve import ProxyMode
+
+from .config import ClientConfig
+
+if TYPE_CHECKING:
+    from cuiman.app import App
+
+
+class ClientAppMixin(ABC):
+    """
+    Extra methods for the Client App.
+    """
+
+    @property
+    @abstractmethod
+    def config(self) -> ClientConfig:
+        """Will be overridden by the actual client class."""
+
+    def show_app(
+        self,
+        *,
+        compact: bool | None = None,
+        debug: bool = False,
+        scheme: Literal["dark", "light", "auto"] = "auto",
+        width: int | str = "100%",
+        height: int | str = 600,
+        display: Literal["browser", "notebook", "auto"] = "auto",
+        proxy: ProxyMode = "auto",
+    ) -> "App":
+        """
+        Show the Cuiman app for this client.
+
+        The app connects to this client's API configuration, renders the app GUI,
+        and returns an object that provides the serve result and a shared
+        [app state][cuiman.app.AppState], which you can interact with.
+
+        The app state currently only manages the process requests being
+        edited and executed by a user. The requests are a mapping from process IDs
+        to process requests.
+
+        Display the app and get the app instance:
+
+        ```
+        app = client.show_app()
+        ```
+
+        You can get and set process requests using the methods
+
+        - ``app.get_process_request(process_id)``
+        - ``app.set_process_request(process_id, process_request)``
+
+        where ``process_id`` is the process ID and ``process_request`` is a dict
+        or a ``ProcessRequest`` object that comprises basically two attributes:
+
+        - ``inputs``: a mapping from input name to an input's value.
+        - ``outputs``: the outputs to be generated. Just used to detect
+          whether an output is included or now.
+
+        Another convenient way to work with the nested app state is the
+        ``process_requests`` property:
+
+        - ``app.process_requests.my_process.inputs.threshold = 0.75``
+        - ``app.process_requests.my_process = {"inputs": {...}}``
+
+        Args:
+            compact: Compact mode. Defaults to True, if ``display`` is "notebook".
+            debug: Enable app debug mode.
+            scheme: Color scheme to use in the app. ``"auto"`` follows the
+                surrounding notebook theme when the app is embedded.
+            width: Width of the notebook iframe.
+            height: Height of the notebook iframe.
+            display: Where to show the app. ``"auto"`` embeds it in notebooks
+                and opens it in a browser otherwise.
+            proxy: Whether notebook traffic uses ``jupyter-server-proxy``. ``"auto"``
+                uses it when available, ``"never"`` disables it, and ``"always"``
+                requires it.
+        Return:
+            An ``App`` instance.
+        """
+        from cuiman.app import App, serve
+
+        display_ = (
+            ("notebook" if has_ishell else "browser") if display == "auto" else display
+        )
+        compact_ = compact if isinstance(compact, bool) else display_ == "notebook"
+
+        remote_store = App.create_remote_store()
+
+        # noinspection PyTypeChecker
+        serve_result = serve(
+            self.config,
+            remote_store,
+            compact=compact_,
+            debug=debug,
+            scheme=scheme,
+            width=width,
+            height=height,
+            display=display_,
+            proxy=proxy,
+        )
+
+        return App(remote_store, serve_result)

{cuiman-0.1.2 → cuiman-0.2.0}/cuiman/api/config.py

@@ -16,10 +16,8 @@ from typing import (
 import yaml
 from pydantic import Field, HttpUrl, field_validator
 from pydantic_settings import BaseSettings, SettingsConfigDict
-from typing_extensions import deprecated
 
 from gavicore.models import InputDescription, ProcessDescription, ProcessSummary
-from gavicore.ui import FieldFactoryRegistry, FieldMeta
 
 from .auth import AuthConfig
 from .defaults import DEFAULT_API_URL
@@ -155,124 +153,6 @@ class ClientConfig(AuthConfig, BaseSettings):
     def validate_api_url(cls, v: str | None) -> str | None:
         return None if v is None or v == "" else str(HttpUrl(v))
 
-    # noinspection PyUnusedLocal
-    @classmethod
-    @deprecated(
-        "ClientConfig.accept_process() is deprecated, only used by the legacy "
-        "cuiman.gui client, and will not work in newer Eozilla versions."
-    )
-    def accept_process(
-        cls, process_summary: ProcessSummary, **filter_kwargs: Any
-    ) -> bool:
-        """
-        Predicate function that is used to filter the list of processes.
-        The function is intended to be overridden by subclasses in order to allow
-        for evaluating the given `process_summary` in an application-specific way.
-        This includes the using custom fields in the given
-        [ProcessSummary][gavicore.models.ProcessSummary] instance.
-
-        Applications may use the [extend_model()][gavicore.util.model.extend_model]
-        function to enhance existing model classes by their custom fields.
-
-        The default implementation unconditionally returns `True`.
-
-        Args:
-            process_summary: A process summary.
-            filter_kwargs: Implementation specific arguments passed
-                by a user of this class.
-
-        Returns:
-            `True` to accept the given process, otherwise `False`.
-        """
-        return True
-
-    # noinspection PyUnusedLocal
-    @classmethod
-    @deprecated(
-        "ClientConfig.accept_input() is deprecated, only used by the legacy "
-        "cuiman.gui client, and will not work in newer Eozilla versions."
-    )
-    def accept_input(
-        cls,
-        process_description: ProcessDescription,
-        input_name: str,
-        input_description: InputDescription,
-        **filter_kwargs: Any,
-    ) -> bool:
-        """
-        Predicate function that is used to filter the list of inputs of a process.
-        The function is intended to be overridden by subclasses in order to allow
-        for evaluating the given `input_description` in an application-specific way.
-        This includes the using custom fields in the given
-        [InputDescription][gavicore.models.InputDescription] instance.
-
-        Applications may use the [extend_model()][gavicore.util.model.extend_model]
-        function to enhance existing model classes by their custom fields.
-
-        The default implementation unconditionally returns `True`.
-
-        Args:
-            process_description: The process description.
-            input_name: The input's name.
-            input_description: A description of an
-                input of the given `process_description`.
-            filter_kwargs: Implementation specific arguments passed
-                by a user of this class.
-
-        Returns:
-            `True` to accept the given input, otherwise `False`.
-        """
-        return True
-
-    # noinspection PyUnusedLocal
-    @classmethod
-    @deprecated(
-        "ClientConfig.is_advanced_input() is deprecated, only used by the legacy "
-        "cuiman.gui client, and will not work in newer Eozilla versions."
-    )
-    def is_advanced_input(
-        cls,
-        process_description: ProcessDescription,
-        input_name: str,
-        input_description: InputDescription,
-    ) -> bool:
-        """
-        Experimental method, do not use!
-
-        Designed to be overridden by a custom `ClientConfig` class
-        from which an instance will be assigned to `ClientConfig.default_config`
-        to become effective.
-
-        The default implementations checks if the given `input_description`
-        has `additionalParameters`, and if so, if a parameter with name
-        `"level"` has value `["advanced"]` (a list!).
-
-        Args:
-            process_description: The process description.
-            input_name: The input's name.
-            input_description: A description of an
-                input of the given `process_description`.
-
-        Returns:
-            `True` if the input is advanced
-            (e.g. for advanced process users only).
-        """
-        # The following approach uses additionalParameters but its use
-        # is discouraged. (We receive such metadata currently from
-        # the TAO Process API).
-        additional_parameters = input_description.additionalParameters
-        if additional_parameters:
-            parameters = additional_parameters.parameters
-            if parameters:
-                for p in parameters:
-                    if p.name == "level" and p.value == ["advanced"]:
-                        return True
-        # The way it should be done is using "x-ui" properties.
-        # Ideally, we should pass an already parsed FieldMeta into the
-        # is_advanced_input() method.
-        field_meta = FieldMeta.from_input_description(input_name, input_description)
-        return field_meta.advanced or field_meta.level == "advanced"
-
     @classmethod
     def register_job_result_opener(
         cls, opener_type: type[JobResultOpener]
@@ -299,33 +179,6 @@ class ClientConfig(AuthConfig, BaseSettings):
         """
         return JobResultOpenerRegistry.create_default()
 
-    @classmethod
-    @cache
-    def get_field_factory_registry(cls) -> FieldFactoryRegistry:
-        """
-        Get the registry for factories that generate UI fields from
-        process inputs.
-
-        Used in the GUI client `cuiman.gui.Client`. Use it to register
-        factories that customize the way the client GUI is generated.
-
-        The default registry contains factories that creates UI fields for
-        the [Panel](https://panel.holoviz.org/) library as this is the primary
-        library used in the GUI client.
-
-        The default registry type is
-        `gavicore.ui.panel.PanelFieldFactoryRegistry`.
-
-        The type of registered field factories is
-        `gavicore.ui.panel.PanelFieldFactory`.
-
-        The type of the field instances created by the factories must be
-        `gavicore.ui.panel.PanelField`.
-        """
-        from gavicore.ui.panel import PanelFieldFactoryRegistry
-
-        return PanelFieldFactoryRegistry.create_default()
-
 
 # Set Eozilla defaults.
 # Cuiman applications might want to change them.