digitalhub 0.11.0b7__py3-none-any.whl → 0.13.0b0__py3-none-any.whl

digitalhub/stores/client/dhcore/models.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 from pydantic import BaseModel

digitalhub/stores/client/dhcore/params_builder.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 from digitalhub.entities._commons.enums import ApiCategories, BackendOperations

digitalhub/stores/client/dhcore/utils.py

@@ -1,10 +1,14 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 import os
 import typing
 
 from digitalhub.stores.client.api import get_client
-from digitalhub.stores.client.dhcore.enums import DhcoreEnvVar
+from digitalhub.stores.credentials.enums import CredsEnvVar
 
 if typing.TYPE_CHECKING:
     from digitalhub.stores.client.dhcore.client import ClientDHCore
@@ -43,20 +47,20 @@ def set_dhcore_env(
     None
     """
     if endpoint is not None:
-        os.environ[DhcoreEnvVar.ENDPOINT.value] = endpoint
+        os.environ[CredsEnvVar.DHCORE_ENDPOINT.value] = endpoint
     if user is not None:
-        os.environ[DhcoreEnvVar.USER.value] = user
+        os.environ[CredsEnvVar.DHCORE_USER.value] = user
     if password is not None:
-        os.environ[DhcoreEnvVar.PASSWORD.value] = password
+        os.environ[CredsEnvVar.DHCORE_PASSWORD.value] = password
     if access_token is not None:
-        os.environ[DhcoreEnvVar.ACCESS_TOKEN.value] = access_token
+        os.environ[CredsEnvVar.DHCORE_ACCESS_TOKEN.value] = access_token
     if refresh_token is not None:
-        os.environ[DhcoreEnvVar.REFRESH_TOKEN.value] = refresh_token
+        os.environ[CredsEnvVar.DHCORE_REFRESH_TOKEN.value] = refresh_token
     if client_id is not None:
-        os.environ[DhcoreEnvVar.CLIENT_ID.value] = client_id
+        os.environ[CredsEnvVar.DHCORE_CLIENT_ID.value] = client_id
 
     client: ClientDHCore = get_client(local=False)
-    client._configurator.configure()
+    client._configurator.load_env_vars()
 
 
 def refresh_token() -> None:

digitalhub/stores/client/local/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0

digitalhub/stores/client/local/api_builder.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 from digitalhub.entities._commons.enums import ApiCategories, BackendOperations

digitalhub/stores/client/local/client.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 from copy import deepcopy

digitalhub/stores/client/local/enums.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 from enum import Enum

digitalhub/stores/client/local/key_builder.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 from digitalhub.stores.client._base.key_builder import ClientKeyBuilder

digitalhub/stores/client/local/params_builder.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 from digitalhub.entities._commons.enums import ApiCategories, BackendOperations

digitalhub/stores/credentials/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0

digitalhub/stores/{configurator → credentials}/api.py

@@ -1,6 +1,10 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
-from digitalhub.stores.configurator.configurator import configurator
+from digitalhub.stores.credentials.handler import creds_handler
 
 
 def set_current_env(environment: str) -> None:
@@ -16,7 +20,7 @@ def set_current_env(environment: str) -> None:
     -------
     None
     """
-    configurator.set_current_env(environment)
+    creds_handler.set_current_env(environment)
 
 
 def get_current_env() -> str:
@@ -28,4 +32,4 @@ def get_current_env() -> str:
     str
         Credentials set name.
     """
-    return configurator.get_current_env()
+    return creds_handler.get_current_env()

digitalhub/stores/credentials/configurator.py

@@ -0,0 +1,37 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from abc import abstractmethod
+
+from digitalhub.stores.credentials.enums import CredsOrigin
+from digitalhub.stores.credentials.handler import creds_handler
+
+
+class Configurator:
+    # Must be set in implementing class
+    keys: list[str] = []
+    required_keys: list[str] = []
+
+    # Origin of the credentials
+    _env = CredsOrigin.ENV.value
+    _file = CredsOrigin.FILE.value
+
+    # Credentials handler
+    _creds_handler = creds_handler
+
+    def get_credentials(self, origin: str) -> dict:
+        return creds_handler.get_credentials(origin)
+
+    @abstractmethod
+    def load_configs(self) -> None:
+        ...
+
+    def _check_credentials(self, creds: dict) -> list[str]:
+        missing_keys = []
+        for k, v in creds.items():
+            if v is None and k in self.required_keys:
+                missing_keys.append(k)
+        return missing_keys

digitalhub/stores/credentials/enums.py

@@ -0,0 +1,54 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class CredsOrigin(Enum):
+    """
+    List credential origins.
+    """
+
+    ENV = "env"
+    FILE = "file"
+
+
+class SetCreds(Enum):
+    """
+    List supported environments.
+    """
+
+    DEFAULT = "__default"
+    DH_ENV = "DH_NAME"
+
+
+class CredsEnvVar(Enum):
+    # S3
+    S3_ENDPOINT_URL = "AWS_ENDPOINT_URL"
+    S3_ACCESS_KEY_ID = "AWS_ACCESS_KEY_ID"
+    S3_SECRET_ACCESS_KEY = "AWS_SECRET_ACCESS_KEY"
+    S3_SESSION_TOKEN = "AWS_SESSION_TOKEN"
+    S3_REGION = "AWS_REGION"
+    S3_SIGNATURE_VERSION = "S3_SIGNATURE_VERSION"
+
+    # SQL
+    DB_HOST = "DB_HOST"
+    DB_PORT = "DB_PORT"
+    DB_USERNAME = "DB_USERNAME"
+    DB_PASSWORD = "DB_PASSWORD"
+    DB_DATABASE = "DB_DATABASE"
+    DB_PG_SCHEMA = "DB_SCHEMA"
+
+    # DHCORE
+    DHCORE_ENDPOINT = "DHCORE_ENDPOINT"
+    DHCORE_ISSUER = "DHCORE_ISSUER"
+    DHCORE_USER = "DHCORE_USER"
+    DHCORE_PASSWORD = "DHCORE_PASSWORD"
+    DHCORE_CLIENT_ID = "DHCORE_CLIENT_ID"
+    DHCORE_ACCESS_TOKEN = "DHCORE_ACCESS_TOKEN"
+    DHCORE_REFRESH_TOKEN = "DHCORE_REFRESH_TOKEN"
+    DHCORE_PERSONAL_ACCESS_TOKEN = "DHCORE_PERSONAL_ACCESS_TOKEN"
+    DHCORE_WORKFLOW_IMAGE = "DHCORE_WORKFLOW_IMAGE"

digitalhub/stores/credentials/handler.py

@@ -0,0 +1,148 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+import os
+
+from digitalhub.stores.credentials.enums import SetCreds
+from digitalhub.stores.credentials.ini_module import load_from_file, read_env_from_file, set_current_env, write_config
+from digitalhub.stores.credentials.store import CredentialsStore
+
+
+class CredentialHandler:
+    """
+    Configurator object used to configure clients and store credentials.
+    """
+
+    def __init__(self) -> None:
+        # Store
+        self._creds_store = CredentialsStore()
+
+        # Current credentials set (__default by default)
+        self._environment = os.getenv(SetCreds.DH_ENV.value, SetCreds.DEFAULT.value)
+
+    ##############################
+    # Public methods
+    ##############################
+
+    def set_current_env(self, creds_set: str) -> None:
+        """
+        Set the current credentials set.
+
+        Parameters
+        ----------
+        creds_set : str
+            Credentials set name.
+
+        Returns
+        -------
+        None
+        """
+        self._environment = creds_set
+        set_current_env(creds_set)
+
+    def get_current_env(self) -> str:
+        """
+        Get the current credentials set.
+
+        Returns
+        -------
+        str
+            Credentials set name.
+        """
+        return self._environment
+
+    def load_from_env(self, var: str) -> str | None:
+        """
+        Load variable from env.
+
+        Parameters
+        ----------
+        var : str
+            Environment variable name.
+
+        Returns
+        -------
+        str | None
+            Environment variable value.
+        """
+        env_var = os.getenv(var)
+        if env_var != "":
+            return env_var
+
+    def load_from_file(self, var: str) -> str | None:
+        """
+        Load variable from config file.
+
+        Parameters
+        ----------
+        var : str
+            Environment variable name.
+
+        Returns
+        -------
+        str | None
+            Environment variable value.
+        """
+        env_from_file = read_env_from_file()
+        if env_from_file is not None:
+            self._environment = env_from_file
+        return load_from_file(var)
+
+    def write_env(self, creds: dict) -> None:
+        """
+        Write the env variables to the .dhcore file.
+
+        Parameters
+        ----------
+        creds : dict
+            Credentials.
+
+        Returns
+        -------
+        None
+        """
+        write_config(creds, self._environment)
+
+    ##############################
+    # Credentials store methods
+    ##############################
+
+    def set_credentials(self, origin: str, creds: dict) -> None:
+        """
+        Set credentials.
+
+        Parameters
+        ----------
+        origin : str
+            The origin of the credentials.
+        creds : dict
+            The credentials.
+
+        Returns
+        -------
+        None
+        """
+        self._creds_store.set_credentials(self._environment, origin, creds)
+
+    def get_credentials(self, origin: str) -> dict:
+        """
+        Get credentials from origin.
+
+        Parameters
+        ----------
+        origin : str
+            The origin of the credentials.
+
+        Returns
+        -------
+        dict
+            The credentials.
+        """
+        return self._creds_store.get_credentials(self._environment, origin)
+
+
+# Define global configurator
+creds_handler = CredentialHandler()

digitalhub/stores/{configurator → credentials}/ini_module.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 from configparser import ConfigParser
@@ -79,7 +83,7 @@ def write_config(creds: dict, environment: str) -> None:
 
         cfg["DEFAULT"]["current_environment"] = environment
         for k, v in creds.items():
-            cfg[environment][k] = v
+            cfg[environment][k] = str(v)
 
         ENV_FILE.touch(exist_ok=True)
         with open(ENV_FILE, "w") as inifile:

digitalhub/stores/credentials/store.py

@@ -0,0 +1,49 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Any
+
+from digitalhub.stores.credentials.enums import CredsOrigin
+
+
+class CredentialsStore:
+    """
+    Credentials store to store and retrieve credentials.
+    """
+
+    def __init__(self) -> None:
+        self._file_creds: dict[str, dict[str, Any]] = {}
+        self._env_creds: dict[str, Any] = {}
+
+    def set_credentials(
+        self,
+        profile: str,
+        origin: str,
+        credentials: dict[str, Any],
+    ) -> None:
+        """
+        Set all credentials for a given profile and origin.
+        """
+        if origin == CredsOrigin.ENV.value:
+            for key, value in credentials.items():
+                self._env_creds[key] = value
+            return
+        if profile not in self._file_creds:
+            self._file_creds[profile] = {}
+        for key, value in credentials.items():
+            self._file_creds[profile][key] = value
+
+    def get_credentials(
+        self,
+        profile: str,
+        origin: str,
+    ) -> dict[str, Any]:
+        """
+        Get all credentials for a given profile and origin.
+        """
+        if origin == CredsOrigin.ENV.value:
+            return self._env_creds
+        return self._file_creds[profile]

digitalhub/stores/data/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0

digitalhub/stores/data/_base/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0

digitalhub/stores/data/_base/store.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 import typing
@@ -12,6 +16,7 @@ from digitalhub.utils.types import SourcesOrListOfSources
 from digitalhub.utils.uri_utils import has_local_scheme
 
 if typing.TYPE_CHECKING:
+    from digitalhub.stores.credentials.configurator import Configurator
     from digitalhub.stores.readers.data._base.reader import DataframeReader
 
 
@@ -20,6 +25,9 @@ class Store:
     Store abstract class.
     """
 
+    def __init__(self, configurator: Configurator | None = None) -> None:
+        self._configurator = configurator
+
     ##############################
     # I/O methods
     ##############################
@@ -27,19 +35,22 @@ class Store:
     @abstractmethod
     def download(
         self,
-        root: str,
+        src: str,
         dst: Path,
-        src: list[str],
         overwrite: bool = False,
     ) -> str:
         """
-        Method to download artifact from storage.
+        Method to download material entity from storage.
         """
 
     @abstractmethod
-    def upload(self, src: SourcesOrListOfSources, dst: str) -> list[tuple[str, str]]:
+    def upload(
+        self,
+        src: SourcesOrListOfSources,
+        dst: str,
+    ) -> list[tuple[str, str]]:
         """
-        Method to upload artifact to storage.
+        Method to upload material entity to storage.
         """
 
     @abstractmethod
@@ -79,7 +90,13 @@ class Store:
         """
 
     @abstractmethod
-    def write_df(self, df: Any, dst: str, extension: str | None = None, **kwargs) -> str:
+    def write_df(
+        self,
+        df: Any,
+        dst: str,
+        extension: str | None = None,
+        **kwargs,
+    ) -> str:
         """
         Write DataFrame as parquet or csv.
         """

digitalhub/stores/data/api.py

@@ -1,13 +1,53 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 import typing
 
+from digitalhub.context.api import get_context
+from digitalhub.stores.credentials.handler import creds_handler
 from digitalhub.stores.data.builder import store_builder
+from digitalhub.stores.data.enums import StoreEnv
 
 if typing.TYPE_CHECKING:
     from digitalhub.stores.data._base.store import Store
 
 
+def get_default_store(project: str) -> str:
+    """
+    Get default store URI.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+
+    Returns
+    -------
+    str
+        Default store URI.
+    """
+    context = get_context(project)
+    store = context.config.get(StoreEnv.DEFAULT_FILES_STORE.value.lower())
+    if store is not None:
+        return store
+
+    store = creds_handler.load_from_env(StoreEnv.DEFAULT_FILES_STORE.value)
+    if store is None:
+        store = creds_handler.load_from_file(StoreEnv.DEFAULT_FILES_STORE.value)
+
+    if store is None or store == "":
+        raise ValueError(
+            "No default store found. "
+            "Please set a default store "
+            f"in your environment (e.g. export {StoreEnv.DEFAULT_FILES_STORE.value}=) "
+            "or set it in project config."
+        )
+    return store
+
+
 def get_store(project: str, uri: str) -> Store:
     """
     Get store instance by URI.
@@ -26,4 +66,4 @@ def get_store(project: str, uri: str) -> Store:
     Store
         Store instance.
     """
-    return store_builder.get(project, uri)
+    return store_builder.get(uri)