digitalhub 0.7.0b2__py3-none-any.whl → 0.8.0__py3-none-any.whl

digitalhub/__init__.py

@@ -1,112 +1,82 @@
-from digitalhub_core import (
+from digitalhub.entities.artifact.crud import (
     delete_artifact,
-    delete_function,
-    delete_project,
-    delete_run,
-    delete_secret,
-    delete_task,
-    delete_workflow,
     get_artifact,
     get_artifact_versions,
+    import_artifact,
+    list_artifacts,
+    log_artifact,
+    new_artifact,
+    update_artifact,
+)
+from digitalhub.entities.dataitem.crud import (
+    delete_dataitem,
+    get_dataitem,
+    get_dataitem_versions,
+    import_dataitem,
+    list_dataitems,
+    log_dataitem,
+    new_dataitem,
+    update_dataitem,
+)
+from digitalhub.entities.function.crud import (
+    delete_function,
     get_function,
     get_function_versions,
-    get_run,
+    import_function,
+    list_functions,
+    new_function,
+    update_function,
+)
+from digitalhub.entities.model.crud import (
+    delete_model,
+    get_model,
+    get_model_versions,
+    import_model,
+    list_models,
+    log_model,
+    new_model,
+    update_model,
+)
+from digitalhub.entities.project.crud import (
+    delete_project,
+    get_or_create_project,
+    get_project,
+    import_project,
+    load_project,
+    new_project,
+    update_project,
+)
+from digitalhub.entities.run.crud import delete_run, get_run, import_run, list_runs, new_run, update_run
+from digitalhub.entities.secret.crud import (
+    delete_secret,
     get_secret,
     get_secret_versions,
-    get_task,
+    import_secret,
+    list_secrets,
+    new_secret,
+    update_secret,
+)
+from digitalhub.entities.task.crud import delete_task, get_task, import_task, list_tasks, new_task, update_task
+from digitalhub.entities.workflow.crud import (
+    delete_workflow,
     get_workflow,
     get_workflow_versions,
-    import_artifact,
-    import_function,
-    import_run,
-    import_secret,
-    import_task,
     import_workflow,
-    list_artifacts,
-    list_functions,
-    list_runs,
-    list_secrets,
-    list_tasks,
     list_workflows,
-    log_artifact,
-    new_artifact,
-    new_function,
-    new_run,
-    new_secret,
-    new_task,
     new_workflow,
-    set_dhcore_env,
-    set_store,
-    update_artifact,
-    update_function,
-    update_project,
-    update_run,
-    update_secret,
-    update_task,
     update_workflow,
 )
-from digitalhub_core.registry.utils import register_layer_entities, register_runtimes_entities
 
-_PROJECT_IMPORTED = False
-
-if not _PROJECT_IMPORTED:
-    try:
-        from digitalhub_data import (
-            delete_dataitem,
-            get_dataitem,
-            get_dataitem_versions,
-            import_dataitem,
-            list_dataitems,
-            log_dataitem,
-            new_dataitem,
-            update_dataitem,
-        )
-        from digitalhub_ml import (
-            delete_model,
-            get_model,
-            get_model_versions,
-            get_or_create_project,
-            get_project,
-            import_model,
-            import_project,
-            list_models,
-            load_project,
-            log_model,
-            new_model,
-            new_project,
-            update_model,
-        )
-
-        _PROJECT_IMPORTED = True
-    except ImportError:
-        ...
-
-if not _PROJECT_IMPORTED:
-    try:
-        from digitalhub_data import (
-            delete_dataitem,
-            get_dataitem,
-            get_dataitem_versions,
-            get_or_create_project,
-            get_project,
-            import_dataitem,
-            import_project,
-            list_dataitems,
-            load_project,
-            log_dataitem,
-            new_dataitem,
-            new_project,
-            update_dataitem,
-        )
-
-        _PROJECT_IMPORTED = True
-    except ImportError:
-        ...
-
-if not _PROJECT_IMPORTED:
-    from digitalhub_core import get_or_create_project, get_project, import_project, load_project, new_project
+try:
+    from digitalhub.entities.model.mlflow.utils import from_mlflow_run
+except ImportError:
+    ...
 
+from digitalhub.client.dhcore.utils import refresh_token, set_dhcore_env
 
 # Register entities into registry
-register_layer_entities()
+from digitalhub.factory.utils import register_entities, register_runtimes_entities
+from digitalhub.stores.api import set_store
+
+register_entities()
 register_runtimes_entities()

digitalhub/client/_base/client.py

@@ -0,0 +1,56 @@
+from __future__ import annotations
+
+from abc import abstractmethod
+
+
+class Client:
+    """
+    Base Client class interface.
+
+    The client is an interface that handles the CRUD of an object during
+    a session. It manages the creation, reading, updating, deleting and
+    listing of objects and comes into two subclasses: Local and DHCore.
+    """
+
+    @abstractmethod
+    def create_object(self, api: str, obj: dict, **kwargs) -> dict:
+        """
+        Create object method.
+        """
+
+    @abstractmethod
+    def read_object(self, api: str, **kwargs) -> dict:
+        """
+        Read object method.
+        """
+
+    @abstractmethod
+    def update_object(self, api: str, obj: dict, **kwargs) -> dict:
+        """
+        Update object method.
+        """
+
+    @abstractmethod
+    def delete_object(self, api: str, **kwargs) -> dict:
+        """
+        Delete object method.
+        """
+
+    @abstractmethod
+    def list_objects(self, api: str, **kwargs) -> dict:
+        """
+        List objects method.
+        """
+
+    @abstractmethod
+    def list_first_object(self, api: str, **kwargs) -> dict:
+        """
+        Read first object method.
+        """
+
+    @staticmethod
+    @abstractmethod
+    def is_local() -> bool:
+        """
+        Flag to check if client is local.
+        """

digitalhub/client/api.py

@@ -0,0 +1,63 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.client.builder import client_builder
+
+if typing.TYPE_CHECKING:
+    from digitalhub.client._base.client import Client
+
+
+def check_client_exists(local: bool = False) -> bool:
+    """
+    Check if client exists.
+
+    Parameters
+    ----------
+    local : bool
+        Check client existence by local.
+
+    Returns
+    -------
+    bool
+        True if client exists, False otherwise.
+    """
+    if local:
+        return client_builder._local is not None
+    return client_builder._dhcore is not None
+
+
+def build_client(local: bool = False, config: dict | None = None) -> None:
+    """
+    Wrapper around ClientBuilder.build.
+
+    Parameters
+    ----------
+    local : bool
+        Whether to create a local client or not.
+    config : dict
+        DHCore environment configuration.
+
+    Returns
+    -------
+    Client
+        The client instance.
+    """
+    client_builder.build(local, config)
+
+
+def get_client(local: bool = False) -> Client:
+    """
+    Wrapper around ClientBuilder.build.
+
+    Parameters
+    ----------
+    local : bool
+        Whether to create a local client or not.
+
+    Returns
+    -------
+    Client
+        The client instance.
+    """
+    return client_builder.build(local)

digitalhub/client/builder.py

@@ -0,0 +1,50 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.client.dhcore.client import ClientDHCore
+from digitalhub.client.local.client import ClientLocal
+
+if typing.TYPE_CHECKING:
+    from digitalhub.client._base.client import Client
+
+
+class ClientBuilder:
+    """
+    Client builder class.
+
+    This class is used to create two possible client instances:
+    Local and DHCore.
+    It saves the client instances in the class attributes using
+    singleton pattern.
+    """
+
+    def __init__(self) -> None:
+        self._local = None
+        self._dhcore = None
+
+    def build(self, local: bool = False, config: dict | None = None) -> Client:
+        """
+        Method to create a client instance.
+
+        Parameters
+        ----------
+        local : bool
+            Whether to create a local client or not.
+
+        Returns
+        -------
+        Client
+            Returns the client instance.
+        """
+        if local:
+            if self._local is None:
+                self._local = ClientLocal()
+            return self._local
+
+        if self._dhcore is None:
+            self._dhcore = ClientDHCore(config)
+        return self._dhcore
+
+
+client_builder = ClientBuilder()