digitalhub 0.8.0b15__py3-none-any.whl → 0.9.0__py3-none-any.whl

digitalhub/client/dhcore/env.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import os
+from pathlib import Path
 
 # Use env user as fallback in the API calls
 try:
@@ -13,9 +14,10 @@ except Exception:
 # but refresh token is only available once. Is it's used, we cannot
 # overwrite it with coder, so we need to store the new one in a file,
 # preserved for jupyter restart
-ENV_FILE = ".dhcore"
+ENV_FILE = Path.home() / ".dhcore"
 
 
 # API levels that are supported
 MAX_API_LEVEL = 20
-MIN_API_LEVEL = 8
+MIN_API_LEVEL = 9
+LIB_VERSION = 9

digitalhub/client/dhcore/key_builder.py

@@ -0,0 +1,58 @@
+from __future__ import annotations
+
+from digitalhub.client._base.key_builder import ClientKeyBuilder
+
+
+class ClientDHCoreKeyBuilder(ClientKeyBuilder):
+    """
+    Class that build the key of entities.
+    """
+
+    def base_entity_key(self, entity_id: str) -> str:
+        """
+        Build for base entity key.
+
+        Parameters
+        ----------
+        entity_id : str
+            Entity id.
+
+        Returns
+        -------
+        str
+            Key.
+        """
+        return f"store://{entity_id}"
+
+    def context_entity_key(
+        self,
+        project: str,
+        entity_type: str,
+        entity_kind: str,
+        entity_name: str,
+        entity_id: str | None = None,
+    ) -> str:
+        """
+        Build for context entity key.
+
+        Parameters
+        ----------
+        project : str
+            Project name.
+        entity_type : str
+            Entity type.
+        entity_kind : str
+            Entity kind.
+        entity_name : str
+            Entity name.
+        entity_id : str
+            Entity ID.
+
+        Returns
+        -------
+        str
+            Key.
+        """
+        if entity_id is None:
+            return f"store://{project}/{entity_type}/{entity_kind}/{entity_name}"
+        return f"store://{project}/{entity_type}/{entity_kind}/{entity_name}:{entity_id}"

digitalhub/client/dhcore/utils.py

@@ -3,7 +3,8 @@ from __future__ import annotations
 import os
 import typing
 
-from digitalhub.client.api import check_client_exists, get_client
+from digitalhub.client.api import get_client
+from digitalhub.client.dhcore.enums import AuthType, DhcoreEnvVar
 
 if typing.TYPE_CHECKING:
     from digitalhub.client.dhcore.client import ClientDHCore
@@ -43,20 +44,19 @@ def set_dhcore_env(
     None
     """
     if endpoint is not None:
-        os.environ["DHCORE_ENDPOINT"] = endpoint
+        os.environ[DhcoreEnvVar.ENDPOINT.value] = endpoint
     if user is not None:
-        os.environ["DHCORE_USER"] = user
+        os.environ[DhcoreEnvVar.USER.value] = user
     if password is not None:
-        os.environ["DHCORE_PASSWORD"] = password
+        os.environ[DhcoreEnvVar.PASSWORD.value] = password
     if access_token is not None:
-        os.environ["DHCORE_ACCESS_TOKEN"] = access_token
+        os.environ[DhcoreEnvVar.ACCESS_TOKEN.value] = access_token
     if refresh_token is not None:
-        os.environ["DHCORE_REFRESH_TOKEN"] = refresh_token
+        os.environ[DhcoreEnvVar.REFRESH_TOKEN.value] = refresh_token
     if client_id is not None:
-        os.environ["DHCORE_CLIENT_ID"] = client_id
+        os.environ[DhcoreEnvVar.CLIENT_ID.value] = client_id
 
-    if check_client_exists(local=False):
-        update_client_from_env()
+    update_client_from_env()
 
 
 def update_client_from_env() -> None:
@@ -70,16 +70,16 @@ def update_client_from_env() -> None:
     client: ClientDHCore = get_client(local=False)
 
     # Update endpoint
-    endpoint = os.getenv("DHCORE_ENDPOINT")
+    endpoint = os.getenv(DhcoreEnvVar.ENDPOINT.value)
     if endpoint is not None:
         client._endpoint_core = endpoint
 
     # Update auth
 
     # If token is set, it will override the other auth options
-    access_token = os.getenv("DHCORE_ACCESS_TOKEN")
-    refresh_token = os.getenv("DHCORE_REFRESH_TOKEN")
-    client_id = os.getenv("DHCORE_CLIENT_ID")
+    access_token = os.getenv(DhcoreEnvVar.ACCESS_TOKEN.value)
+    refresh_token = os.getenv(DhcoreEnvVar.REFRESH_TOKEN.value)
+    client_id = os.getenv(DhcoreEnvVar.CLIENT_ID.value)
 
     if access_token is not None:
         if refresh_token is not None:
@@ -87,16 +87,16 @@ def update_client_from_env() -> None:
         if client_id is not None:
             client._client_id = client_id
         client._access_token = access_token
-        client._auth_type = "oauth2"
+        client._auth_type = AuthType.OAUTH2.value
         return
 
     # Otherwise, if user and password are set, basic auth will be used
-    username = os.getenv("DHCORE_USER")
-    password = os.getenv("DHCORE_PASSWORD")
+    username = os.getenv(DhcoreEnvVar.USER.value)
+    password = os.getenv(DhcoreEnvVar.PASSWORD.value)
     if username is not None and password is not None:
         client._user = username
         client._password = password
-        client._auth_type = "basic"
+        client._auth_type = AuthType.BASIC.value
 
 
 def refresh_token() -> None:

digitalhub/client/local/api_builder.py

@@ -0,0 +1,100 @@
+from __future__ import annotations
+
+from digitalhub.client._base.api_builder import ClientApiBuilder
+from digitalhub.entities._commons.enums import ApiCategories, BackendOperations
+from digitalhub.utils.exceptions import BackendError
+
+API_BASE = "/api/v1"
+API_CONTEXT = f"{API_BASE}/-"
+
+
+class ClientLocalApiBuilder(ClientApiBuilder):
+    """
+    This class is used to build the API for the Local client.
+    """
+
+    def build_api(self, category: str, operation: str, **kwargs) -> str:
+        """
+        Build the API for the client.
+
+        Parameters
+        ----------
+        category : str
+            API category.
+        operation : str
+            API operation.
+        **kwargs : dict
+            Additional parameters.
+
+        Returns
+        -------
+        str
+            API formatted.
+        """
+        if category == ApiCategories.BASE.value:
+            return self.build_api_base(operation, **kwargs)
+        return self.build_api_context(operation, **kwargs)
+
+    def build_api_base(self, operation: str, **kwargs) -> str:
+        """
+        Build the base API for the client.
+
+        Parameters
+        ----------
+        operation : str
+            API operation.
+        **kwargs : dict
+            Additional parameters.
+
+        Returns
+        -------
+        str
+            API formatted.
+        """
+        entity_type = kwargs["entity_type"] + "s"
+        if operation in (
+            BackendOperations.CREATE.value,
+            BackendOperations.LIST.value,
+        ):
+            return f"{API_BASE}/{entity_type}"
+        elif operation in (
+            BackendOperations.READ.value,
+            BackendOperations.UPDATE.value,
+            BackendOperations.DELETE.value,
+        ):
+            return f"{API_BASE}/{entity_type}/{kwargs['entity_name']}"
+        elif operation == BackendOperations.SHARE.value:
+            raise BackendError("Share API not implemented for Local.")
+        raise BackendError(f"Invalid operation '{operation}' for entity type '{entity_type}' in Local.")
+
+    def build_api_context(self, operation: str, **kwargs) -> str:
+        """
+        Build the context API for the client.
+        """
+        entity_type = kwargs["entity_type"] + "s"
+        project = kwargs["project"]
+        if operation in (
+            BackendOperations.CREATE.value,
+            BackendOperations.LIST.value,
+        ):
+            return f"{API_CONTEXT}/{project}/{entity_type}"
+        elif operation in (
+            BackendOperations.READ.value,
+            BackendOperations.UPDATE.value,
+            BackendOperations.DELETE.value,
+        ):
+            return f"{API_CONTEXT}/{project}/{entity_type}/{kwargs['entity_id']}"
+        elif operation == BackendOperations.LOGS.value:
+            raise BackendError("Logs run API not implemented for Local.")
+        elif operation == BackendOperations.STOP.value:
+            raise BackendError("Stop run API not implemented for Local.")
+        elif operation == BackendOperations.RESUME.value:
+            raise BackendError("Resume run API not implemented for Local.")
+        elif operation == BackendOperations.DATA.value:
+            raise BackendError("Secret API (read/set value) not implemented for Local.")
+        elif operation == BackendOperations.FILES.value:
+            raise BackendError("Files API not implemented for Local.")
+        elif operation == BackendOperations.SEARCH.value:
+            raise BackendError("Search API not implemented for Local.")
+
+        raise BackendError(f"Invalid operation '{operation}' for entity type '{entity_type}' in Local.")

digitalhub/client/local/client.py

@@ -4,6 +4,8 @@ from copy import deepcopy
 from datetime import datetime, timezone
 
 from digitalhub.client._base.client import Client
+from digitalhub.client.local.api_builder import ClientLocalApiBuilder
+from digitalhub.client.local.key_builder import ClientLocalKeyBuilder
 from digitalhub.utils.exceptions import BackendError
 
 
@@ -22,6 +24,8 @@ class ClientLocal(Client):
 
     def __init__(self) -> None:
         super().__init__()
+        self._api_builder = ClientLocalApiBuilder()
+        self._key_builder = ClientLocalKeyBuilder()
         self._db: dict[str, dict[str, dict]] = {}
 
     ##############################
@@ -349,6 +353,24 @@ class ClientLocal(Client):
         except IndexError:
             raise IndexError("No objects found")
 
+    def search_objects(self, api: str, **kwargs) -> dict:
+        """
+        Search objects from Local.
+
+        Parameters
+        ----------
+        api : str
+            Search API.
+        **kwargs : dict
+            Keyword arguments to pass to the request.
+
+        Returns
+        -------
+        dict
+            Response objects.
+        """
+        raise NotImplementedError("Local client does not support search_objects.")
+
     ##############################
     # Helpers
     ##############################

digitalhub/client/local/key_builder.py

@@ -0,0 +1,58 @@
+from __future__ import annotations
+
+from digitalhub.client._base.key_builder import ClientKeyBuilder
+
+
+class ClientLocalKeyBuilder(ClientKeyBuilder):
+    """
+    Class that build the key of entities.
+    """
+
+    def base_entity_key(self, entity_id: str) -> str:
+        """
+        Build for base entity key.
+
+        Parameters
+        ----------
+        entity_id : str
+            Entity id.
+
+        Returns
+        -------
+        str
+            Key.
+        """
+        return f"store://{entity_id}"
+
+    def context_entity_key(
+        self,
+        project: str,
+        entity_type: str,
+        entity_kind: str,
+        entity_name: str,
+        entity_id: str | None = None,
+    ) -> str:
+        """
+        Build for context entity key.
+
+        Parameters
+        ----------
+        project : str
+            Project name.
+        entity_type : str
+            Entity type.
+        entity_kind : str
+            Entity kind.
+        entity_name : str
+            Entity name.
+        entity_id : str
+            Entity ID.
+
+        Returns
+        -------
+        str
+            Key.
+        """
+        if entity_id is None:
+            return f"store://{project}/{entity_type}/{entity_kind}/{entity_name}"
+        return f"store://{project}/{entity_type}/{entity_kind}/{entity_name}:{entity_id}"

digitalhub/context/api.py

@@ -3,45 +3,26 @@ from __future__ import annotations
 import typing
 
 from digitalhub.context.builder import context_builder
-from digitalhub.utils.exceptions import ContextError
 
 if typing.TYPE_CHECKING:
     from digitalhub.context.context import Context
     from digitalhub.entities.project._base.entity import Project
 
 
-def check_context(project: str) -> None:
-    """
-    Check if the given project is in the context.
-
-    Parameters
-    ----------
-    project : str
-        Project name.
-
-    Returns
-    -------
-    bool
-        True if the project is in the context, False otherwise.
-    """
-    if project not in context_builder._instances:
-        raise ContextError
-
-
-def set_context(project: Project) -> None:
+def build_context(project: Project, overwrite: bool = False) -> None:
     """
     Wrapper for ContextBuilder.build().
 
     Parameters
     ----------
     project : Project
-        The project object used to set the current context.
+        The project object used to build the context.
 
     Returns
     -------
     None
     """
-    context_builder.build(project)
+    context_builder.build(project, overwrite)
 
 
 def get_context(project: str) -> Context:
@@ -61,22 +42,6 @@ def get_context(project: str) -> Context:
     return context_builder.get(project)
 
 
-def set_context_object(context: Context) -> None:
-    """
-    Wrapper for ContextBuilder.set().
-
-    Parameters
-    ----------
-    context : Context
-        The context to set.
-
-    Returns
-    -------
-    None
-    """
-    context_builder.set(context)
-
-
 def delete_context(project: str) -> None:
     """
     Wrapper for ContextBuilder.remove().

digitalhub/context/builder.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 import typing
 
 from digitalhub.context.context import Context
+from digitalhub.utils.exceptions import ContextError
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities.project._base.entity import Project
@@ -19,7 +20,7 @@ class ContextBuilder:
     def __init__(self) -> None:
         self._instances: dict[str, Context] = {}
 
-    def build(self, project_object: Project) -> None:
+    def build(self, project_object: Project, overwrite: bool = False) -> None:
         """
         Add a project as context.
 
@@ -27,12 +28,15 @@ class ContextBuilder:
         ----------
         project_object : Project
             The project to add.
+        overwrite : bool
+            If True, the project will be overwritten if it already exists.
 
         Returns
         -------
         None
         """
-        self._instances[project_object.name] = Context(project_object)
+        if (project_object.name not in self._instances) or overwrite:
+            self._instances[project_object.name] = Context(project_object)
 
     def get(self, project: str) -> Context:
         """
@@ -53,12 +57,10 @@ class ContextBuilder:
         ValueError
             If the project is not in the context.
         """
-        ctx = self._instances.get(project)
-        if ctx is None:
-            raise ValueError(
-                f"Context '{project}' not found. Please get or create a project named '{project}' to access its objects."
-            )
-        return ctx
+        try:
+            return self._instances[project]
+        except KeyError:
+            raise ContextError(f"Context '{project}' not found. Get or create a project named '{project}'.")
 
     def remove(self, project: str) -> None:
         """
@@ -75,20 +77,5 @@ class ContextBuilder:
         """
         self._instances.pop(project, None)
 
-    def set(self, context: Context) -> None:
-        """
-        Set the context.
-
-        Parameters
-        ----------
-        context : Context
-            The context to set.
-
-        Returns
-        -------
-        None
-        """
-        self._instances[context.name] = context
-
 
 context_builder = ContextBuilder()

digitalhub/context/context.py

@@ -13,8 +13,6 @@ class Context:
     some information about the project, such as the project name,
     a client instance (local or non-local), the local context
     project path and information about client locality.
-    It exposes CRUD operations for the entities and act as a layer
-    between the project object and its client.
     """
 
     def __init__(self, project: Project) -> None:
@@ -22,115 +20,45 @@ class Context:
         self.client = project._client
         self.local = project._client.is_local()
         self.root = Path(project.spec.context)
+        self.root.mkdir(parents=True, exist_ok=True)
 
-    def create_object(self, api: str, obj: dict, **kwargs) -> dict:
-        """
-        Create an object.
-
-        Parameters
-        ----------
-        api : str
-            Create API.
-        obj : dict
-            Object to create.
-        **kwargs : dict
-            Keyword arguments passed to the request.
-
-        Returns
-        -------
-        dict
-            Response object.
-        """
-        return self.client.create_object(api, obj, **kwargs)
-
-    def read_object(self, api: str, **kwargs) -> dict:
-        """
-        Read an object.
-
-        Parameters
-        ----------
-        api : str
-            Read API.
-        **kwargs : dict
-            Keyword arguments passed to the request.
-
-        Returns
-        -------
-        dict
-            Response object.
-        """
-        return self.client.read_object(api, **kwargs)
-
-    def update_object(self, api: str, obj: dict, **kwargs) -> dict:
-        """
-        Update an object.
-
-        Parameters
-        ----------
-        api : str
-            Update API.
-        obj : dict
-            Object to update.
-        **kwargs : dict
-            Keyword arguments passed to the request.
-
-        Returns
-        -------
-        dict
-            Response object.
-        """
-        return self.client.update_object(api, obj, **kwargs)
+        self.is_running: bool = False
+        self._run_ctx: str = None
 
-    def delete_object(self, api: str, **kwargs) -> dict:
+    def set_run(self, run_ctx: str) -> None:
         """
-        Delete an object.
+        Set run identifier.
 
         Parameters
         ----------
-        api : str
-            Delete API.
-        **kwargs : dict
-            Keyword arguments passed to the request.
+        run_ctx : str
+            Run key.
 
         Returns
         -------
-        dict
-            Response object.
+        None
         """
-        return self.client.delete_object(api, **kwargs)
+        self.is_running = True
+        self._run_ctx = run_ctx
 
-    def list_objects(self, api: str, **kwargs) -> dict:
+    def unset_run(self) -> None:
         """
-        List objects.
-
-        Parameters
-        ----------
-        api : str
-            The api to list the objects with.
-        **kwargs : dict
-            Keyword arguments passed to the request.
+        Unset run identifier.
 
         Returns
         -------
-        dict
-            The list of objects.
+        None
         """
-        return self.client.list_objects(api, **kwargs)
+        self.is_running = False
+        self._run_ctx = None
 
-    def list_first_object(self, api: str, **kwargs) -> dict:
+    def get_run_ctx(self) -> str:
         """
-        List first objects.
-
-        Parameters
-        ----------
-        api : str
-            The api to list the objects with.
-        **kwargs : dict
-            Keyword arguments passed to the request.
+        Get run identifier.
 
         Returns
         -------
-        dict
-            The list of objects.
+        str
+            Run key.
         """
-        return self.client.list_first_object(api, **kwargs)
+        return self._run_ctx