digitalhub 0.9.0b4__tar.gz → 0.9.2__tar.gz

{digitalhub-0.9.0b4 → digitalhub-0.9.2}/LICENSE.txt

@@ -186,7 +186,7 @@ APPENDIX: How to apply the Apache License to your work.
    same "printed page" as the copyright notice for easier
    identification within third-party archives.
 
-Copyright [yyyy] [name of copyright owner]
+Copyright 2024 DSLab, Fondazione Bruno Kessler
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

{digitalhub-0.9.0b4 → digitalhub-0.9.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: digitalhub
-Version: 0.9.0b4
+Version: 0.9.2
 Summary: Python SDK for Digitalhub
 Author-email: Fondazione Bruno Kessler <dslab@fbk.eu>, Matteo Martini <mmartini@fbk.eu>
 License:                               Apache License
@@ -191,7 +191,7 @@ License:                               Apache License
            same "printed page" as the copyright notice for easier
            identification within third-party archives.
         
-        Copyright [yyyy] [name of copyright owner]
+        Copyright 2024 DSLab, Fondazione Bruno Kessler
         
         Licensed under the Apache License, Version 2.0 (the "License");
         you may not use this file except in compliance with the License.

{digitalhub-0.9.0b4 → digitalhub-0.9.2}/digitalhub/client/_base/client.py

@@ -1,8 +1,11 @@
 from __future__ import annotations
 
+import typing
 from abc import abstractmethod
 
-from digitalhub.client._base.api_builder import ClientApiBuilder
+if typing.TYPE_CHECKING:
+    from digitalhub.client._base.api_builder import ClientApiBuilder
+    from digitalhub.client._base.key_builder import ClientKeyBuilder
 
 
 class Client:
@@ -16,26 +19,11 @@ class Client:
 
     def __init__(self) -> None:
         self._api_builder: ClientApiBuilder = None
+        self._key_builder: ClientKeyBuilder = None
 
-    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.
-        """
-        return self._api_builder.build_api(category, operation, **kwargs)
+    ##############################
+    # CRUD methods
+    ##############################
 
     @abstractmethod
     def create_object(self, api: str, obj: dict, **kwargs) -> dict:
@@ -79,6 +67,54 @@ class Client:
         Search objects method.
         """
 
+    ##############################
+    # Build methods
+    ##############################
+
+    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.
+        """
+        return self._api_builder.build_api(category, operation, **kwargs)
+
+    def build_key(self, category: str, *args, **kwargs) -> str:
+        """
+        Build the key for the client.
+
+        Parameters
+        ----------
+        category : str
+            Key category.
+        *args : tuple
+            Additional arguments.
+        **kwargs : dict
+            Additional parameters.
+
+        Returns
+        -------
+        str
+            Key formatted.
+        """
+        return self._key_builder.build_key(category, *args, **kwargs)
+
+    ##############################
+    # Interface methods
+    ##############################
+
     @staticmethod
     @abstractmethod
     def is_local() -> bool:

digitalhub-0.9.2/digitalhub/client/_base/key_builder.py

@@ -0,0 +1,52 @@
+from __future__ import annotations
+
+from abc import abstractmethod
+
+from digitalhub.entities._commons.enums import ApiCategories
+
+
+class ClientKeyBuilder:
+    """
+    Class that build the key of entities.
+    """
+
+    def build_key(self, category: str, *args, **kwargs) -> str:
+        """
+        Build key.
+
+        Parameters
+        ----------
+        category : str
+            Key category.
+        *args : tuple
+            Positional arguments.
+        **kwargs : dict
+            Keyword arguments.
+
+        Returns
+        -------
+        str
+            Key.
+        """
+        if category == ApiCategories.BASE.value:
+            return self.base_entity_key(*args, **kwargs)
+        return self.context_entity_key(*args, **kwargs)
+
+    @abstractmethod
+    def base_entity_key(self, entity_id: str) -> str:
+        """
+        Build for base entity key.
+        """
+
+    @abstractmethod
+    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.
+        """

{digitalhub-0.9.0b4 → digitalhub-0.9.2}/digitalhub/client/dhcore/api_builder.py

@@ -91,7 +91,7 @@ class ClientDHCoreApiBuilder(ClientApiBuilder):
         elif operation == BackendOperations.RESUME.value:
             return f"{API_CONTEXT}/{project}/{entity_type}/{kwargs['entity_id']}/resume"
         elif operation == BackendOperations.DATA.value:
-            return f"{API_CONTEXT}/{project}/{entity_type}/{kwargs['entity_id']}/data"
+            return f"{API_CONTEXT}/{project}/{entity_type}/data"
         elif operation == BackendOperations.FILES.value:
             return f"{API_CONTEXT}/{project}/{entity_type}/{kwargs['entity_id']}/files/info"
         elif operation == BackendOperations.SEARCH.value:

{digitalhub-0.9.0b4 → digitalhub-0.9.2}/digitalhub/client/dhcore/client.py

@@ -14,6 +14,7 @@ from digitalhub.client._base.client import Client
 from digitalhub.client.dhcore.api_builder import ClientDHCoreApiBuilder
 from digitalhub.client.dhcore.enums import AuthType, DhcoreEnvVar
 from digitalhub.client.dhcore.env import ENV_FILE, FALLBACK_USER, LIB_VERSION, MAX_API_LEVEL, MIN_API_LEVEL
+from digitalhub.client.dhcore.key_builder import ClientDHCoreKeyBuilder
 from digitalhub.client.dhcore.models import BasicAuth, OAuth2TokenAuth
 from digitalhub.utils.exceptions import (
     BackendError,
@@ -52,6 +53,9 @@ class ClientDHCore(Client):
         # API builder
         self._api_builder = ClientDHCoreApiBuilder()
 
+        # Key builder
+        self._key_builder = ClientDHCoreKeyBuilder()
+
         # Endpoints
         self._endpoint_core: str | None = None
         self._endpoint_issuer: str | None = None

digitalhub-0.9.2/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-0.9.0b4 → digitalhub-0.9.2}/digitalhub/client/local/client.py

@@ -5,6 +5,7 @@ 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
 
 
@@ -24,6 +25,7 @@ class ClientLocal(Client):
     def __init__(self) -> None:
         super().__init__()
         self._api_builder = ClientLocalApiBuilder()
+        self._key_builder = ClientLocalKeyBuilder()
         self._db: dict[str, dict[str, dict]] = {}
 
     ##############################

digitalhub-0.9.2/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-0.9.0b4 → digitalhub-0.9.2}/digitalhub/entities/_base/project/entity.py

@@ -40,7 +40,7 @@ class ProjectEntity(Entity):
         super().__init__(kind, metadata, spec, status, user)
         self.id = name
         self.name = name
-        self.key = f"store://{name}"
+        self.key = processor.build_project_key(self.name, local=local)
 
         self._obj_attr.extend(["id", "name"])
 

{digitalhub-0.9.0b4 → digitalhub-0.9.2}/digitalhub/entities/_base/unversioned/entity.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 import typing
 
 from digitalhub.entities._base.context.entity import ContextEntity
+from digitalhub.entities._operations.processor import processor
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities._base.entity.metadata import Metadata
@@ -24,4 +25,4 @@ class UnversionedEntity(ContextEntity):
         super().__init__(project, kind, metadata, spec, status, user)
         self.id = uuid
         self.name = uuid
-        self.key = f"store://{project}/{self.ENTITY_TYPE}/{kind}/{uuid}"
+        self.key = processor.build_context_entity_key(project, self.ENTITY_TYPE, kind, uuid)

{digitalhub-0.9.0b4 → digitalhub-0.9.2}/digitalhub/entities/_base/versioned/entity.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 import typing
 
 from digitalhub.entities._base.context.entity import ContextEntity
+from digitalhub.entities._operations.processor import processor
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities._base.entity.metadata import Metadata
@@ -25,4 +26,4 @@ class VersionedEntity(ContextEntity):
         super().__init__(project, kind, metadata, spec, status, user)
         self.name = name
         self.id = uuid
-        self.key = f"store://{project}/{self.ENTITY_TYPE}/{kind}/{name}:{uuid}"
+        self.key = processor.build_context_entity_key(project, self.ENTITY_TYPE, kind, name, uuid)

{digitalhub-0.9.0b4 → digitalhub-0.9.2}/digitalhub/entities/_operations/processor.py

@@ -427,6 +427,55 @@ class OperationsProcessor:
             **kwargs,
         )
 
+    ##############################
+    # Base entity operations
+    ##############################
+
+    def _build_base_entity_key(
+        self,
+        client: Client,
+        entity_id: str,
+    ) -> str:
+        """
+        Build object key.
+
+        Parameters
+        ----------
+        client : Client
+            Client instance.
+        entity_id : str
+            Entity ID.
+
+        Returns
+        -------
+        str
+            Object key.
+        """
+        return client.build_key(ApiCategories.BASE.value, entity_id)
+
+    def build_project_key(
+        self,
+        entity_id: str,
+        **kwargs,
+    ) -> str:
+        """
+        Build object key.
+
+        Parameters
+        ----------
+        entity_id : str
+            Entity ID.
+        **kwargs : dict
+            Parameters to pass to entity builder.
+
+        Returns
+        -------
+        str
+            Object key.
+        """
+        client = get_client(kwargs.pop("local", False))
+        return self._build_base_entity_key(client, entity_id)
+
     def share_project_entity(
         self,
         entity_type: str,
@@ -1279,6 +1328,76 @@ class OperationsProcessor:
     # Context entity operations
     ##############################
 
+    def _build_context_entity_key(
+        self,
+        context: Context,
+        entity_type: str,
+        entity_kind: str,
+        entity_name: str,
+        entity_id: str | None = None,
+    ) -> str:
+        """
+        Build object key.
+
+        Parameters
+        ----------
+        context : Context
+            Context instance.
+        entity_type : str
+            Entity type.
+        entity_kind : str
+            Entity kind.
+        entity_name : str
+            Entity name.
+        entity_id : str
+            Entity ID.
+
+        Returns
+        -------
+        str
+            Object key.
+        """
+        return context.client.build_key(
+            ApiCategories.CONTEXT.value,
+            project=context.name,
+            entity_type=entity_type,
+            entity_kind=entity_kind,
+            entity_name=entity_name,
+            entity_id=entity_id,
+        )
+
+    def build_context_entity_key(
+        self,
+        project: str,
+        entity_type: str,
+        entity_kind: str,
+        entity_name: str,
+        entity_id: str | None = None,
+    ) -> str:
+        """
+        Build object 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
+            Object key.
+        """
+        context = self._get_context(project)
+        return self._build_context_entity_key(context, entity_type, entity_kind, entity_name, entity_id)
+
     def read_secret_data(
         self,
         project: str,

{digitalhub-0.9.0b4 → digitalhub-0.9.2}/digitalhub/utils/git_utils.py

@@ -13,16 +13,16 @@ except ImportError as e:
         warnings.warn("git is not installed. Please install git and try again.", RuntimeWarning)
 
 
-def clone_repository(url: str, path: Path) -> None:
+def clone_repository(path: Path, url: str) -> None:
     """
     Clone git repository.
 
     Parameters
     ----------
-    url : str
-        URL of the repository.
     path : Path
         Path where to save the repository.
+    url : str
+        URL of the repository.
 
     Returns
     -------