digitalhub 0.12.0__py3-none-any.whl → 0.13.0b0__py3-none-any.whl

digitalhub/stores/client/dhcore/utils.py

@@ -8,7 +8,7 @@ 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
@@ -47,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/{configurator → credentials}/api.py

@@ -4,7 +4,7 @@
 
 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:
@@ -20,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:
@@ -32,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/{configurator/configurator.py → credentials/handler.py}

@@ -6,12 +6,12 @@ from __future__ import annotations
 
 import os
 
-from digitalhub.stores.configurator.credentials_store import CredentialsStore
-from digitalhub.stores.configurator.enums import SetCreds
-from digitalhub.stores.configurator.ini_module import load_from_file, read_env_from_file, set_current_env, write_config
+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 EnvConfigurator:
+class CredentialHandler:
     """
     Configurator object used to configure clients and store credentials.
     """
@@ -54,31 +54,6 @@ class EnvConfigurator:
         """
         return self._environment
 
-    ##############################
-    # Private methods
-    ##############################
-
-    def load_var(self, var_name: str) -> str | None:
-        """
-        Get env variable from credentials store, env or file (in order).
-
-        Parameters
-        ----------
-        var_name : str
-            Environment variable name.
-
-        Returns
-        -------
-        str | None
-            Environment variable value.
-        """
-        var = self.get_credential(var_name)
-        if var is None:
-            var = self.load_from_env(var_name)
-        if var is None:
-            var = self.load_from_file(var_name)
-        return var
-
     def load_from_env(self, var: str) -> str | None:
         """
         Load variable from env.
@@ -111,92 +86,63 @@ class EnvConfigurator:
         str | None
             Environment variable value.
         """
-        self._environment = read_env_from_file()
+        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, key_to_include: list[str] | None = None) -> None:
+    def write_env(self, creds: dict) -> None:
         """
         Write the env variables to the .dhcore file.
-        It will overwrite any existing env variables.
 
         Parameters
         ----------
-        key_to_include : list[str]
-            List of keys to include.
+        creds : dict
+            Credentials.
 
         Returns
         -------
         None
         """
-        if key_to_include is None:
-            key_to_include = []
-        creds = self.get_credential_list(key_to_include)
         write_config(creds, self._environment)
 
     ##############################
     # Credentials store methods
     ##############################
 
-    def set_credential(self, key: str, value: str) -> None:
+    def set_credentials(self, origin: str, creds: dict) -> None:
         """
-        Register a credential value.
+        Set credentials.
 
         Parameters
         ----------
-        key : str
-            The key.
-        value : str
-            The value.
+        origin : str
+            The origin of the credentials.
+        creds : dict
+            The credentials.
 
         Returns
         -------
         None
         """
-        self._creds_store.set(self._environment, key, value)
+        self._creds_store.set_credentials(self._environment, origin, creds)
 
-    def get_credential(self, key: str) -> dict:
+    def get_credentials(self, origin: str) -> dict:
         """
-        Get single credential value from key.
+        Get credentials from origin.
 
         Parameters
         ----------
-        key : str
-            The key.
-
-        Returns
-        -------
-        dict
-            The credential.
-        """
-        return self._creds_store.get(self._environment, key)
-
-    def get_all_credentials(self) -> dict:
-        """
-        Get all the credentials from the current credentials set.
+        origin : str
+            The origin of the credentials.
 
         Returns
         -------
         dict
             The credentials.
         """
-        return self._creds_store.get_all(self._environment)
-
-    def get_credential_list(self, keys: list[str]) -> list[str]:
-        """
-        Get the list of credentials.
-
-        Parameters
-        ----------
-        keys : list[str]
-            The list of keys.
-
-        Returns
-        -------
-        list[str]
-            The list of credentials.
-        """
-        return {k: v for k, v in self.get_all_credentials().items() if k in keys}
+        return self._creds_store.get_credentials(self._environment, origin)
 
 
 # Define global configurator
-configurator = EnvConfigurator()
+creds_handler = CredentialHandler()

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

@@ -83,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/_base/store.py

@@ -16,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
 
 
@@ -24,6 +25,9 @@ class Store:
     Store abstract class.
     """
 
+    def __init__(self, configurator: Configurator | None = None) -> None:
+        self._configurator = configurator
+
     ##############################
     # I/O methods
     ##############################
@@ -31,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
@@ -83,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

@@ -6,12 +6,48 @@ 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.
@@ -30,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)

digitalhub/stores/data/builder.py

@@ -6,40 +6,25 @@ from __future__ import annotations
 
 import typing
 
-from digitalhub.stores.configurator.api import get_current_env
+from digitalhub.stores.credentials.api import get_current_env
 from digitalhub.stores.data.local.store import LocalStore
 from digitalhub.stores.data.remote.store import RemoteStore
+from digitalhub.stores.data.s3.configurator import S3StoreConfigurator
 from digitalhub.stores.data.s3.store import S3Store
+from digitalhub.stores.data.sql.configurator import SqlStoreConfigurator
 from digitalhub.stores.data.sql.store import SqlStore
 from digitalhub.utils.uri_utils import SchemeCategory, map_uri_scheme
 
 if typing.TYPE_CHECKING:
+    from digitalhub.stores.credentials.configurator import Configurator
     from digitalhub.stores.data._base.store import Store
+    from digitalhub.utils.exceptions import StoreError
 
 
-def _get_class_from_type(type: str) -> Store:
-    """
-    Get a store class from its type.
-
-    Parameters
-    ----------
-    type : str
-        Store type.
-
-    Returns
-    -------
-    Store
-        The store class.
-    """
-    if type == SchemeCategory.LOCAL.value:
-        return LocalStore
-    if type == SchemeCategory.S3.value:
-        return S3Store
-    if type == SchemeCategory.REMOTE.value:
-        return RemoteStore
-    if type == SchemeCategory.SQL.value:
-        return SqlStore
-    raise ValueError(f"Unknown store type: {type}")
+class StoreInfo:
+    def __init__(self, store: Store, configurator: Configurator | None = None) -> None:
+        self._store = store
+        self._configurator = configurator
 
 
 class StoreBuilder:
@@ -48,50 +33,58 @@ class StoreBuilder:
     """
 
     def __init__(self) -> None:
+        self._builders: dict[str, StoreInfo] = {}
         self._instances: dict[str, dict[str, Store]] = {}
 
-    def build(self, project: str, store_type: str) -> None:
+    def register(
+        self,
+        store_type: str,
+        store: Store,
+        configurator: Configurator | None = None,
+    ) -> None:
+        if store_type not in self._builders:
+            self._builders[store_type] = StoreInfo(store, configurator)
+        else:
+            raise StoreError(f"Store type {store_type} already registered")
+
+    def get(self, uri: str) -> Store:
         """
-        Build a store instance and register it.
-
-        Parameters
-        ----------
-        store_type : str
-            Store type.
-        config : dict
-
-        Returns
-        -------
-        None
-        """
-        env = get_current_env()
-        if env not in self._instances:
-            self._instances[env] = {}
-        self._instances[env][store_type] = _get_class_from_type(store_type)()
-
-    def get(self, project: str, uri: str) -> Store:
-        """
-        Get a store instance by URI.
+        Get a store instance by URI, building it if necessary.
 
         Parameters
         ----------
         uri : str
             URI to parse.
-        config : dict
-            Store configuration.
 
         Returns
         -------
         Store
             The store instance.
         """
-        env = get_current_env()
+        env_profile = get_current_env()
         store_type = map_uri_scheme(uri)
-        try:
-            return self._instances[env][store_type]
-        except KeyError:
-            self.build(project, store_type)
-            return self._instances[env][store_type]
+
+        # Ensure env exists in _instances
+        if env_profile not in self._instances:
+            self._instances[env_profile] = {}
+
+        # Build the store instance if not already present
+        if store_type not in self._instances[env_profile]:
+            store_info = self._builders[store_type]
+            store_cls = store_info._store
+            cfgrt_cls = store_info._configurator
+
+            if cfgrt_cls is None:
+                store = store_cls()
+            else:
+                store = store_cls(cfgrt_cls())
+            self._instances[env_profile][store_type] = store
+
+        return self._instances[env_profile][store_type]
 
 
 store_builder = StoreBuilder()
+store_builder.register(SchemeCategory.S3.value, S3Store, S3StoreConfigurator)
+store_builder.register(SchemeCategory.SQL.value, SqlStore, SqlStoreConfigurator)
+store_builder.register(SchemeCategory.LOCAL.value, LocalStore)
+store_builder.register(SchemeCategory.REMOTE.value, RemoteStore)

digitalhub/stores/data/local/store.py

@@ -29,7 +29,6 @@ class LocalStore(Store):
         self,
         root: str,
         dst: Path,
-        src: list[str],
         overwrite: bool = False,
     ) -> str:
         """
@@ -37,19 +36,17 @@ class LocalStore(Store):
 
         Parameters
         ----------
-        root : str
-            The root path of the artifact.
+        src : str
+            Path of the material entity.
         dst : str
-            The destination of the artifact on local filesystem.
-        src : list[str]
-            List of sources.
+            The destination of the material entity on local filesystem.
         overwrite : bool
             Specify if overwrite existing file(s).
 
         Returns
         -------
         str
-            Destination path of the downloaded artifact.
+            Destination path of the downloaded files.
         """
         raise StoreError("Local store does not support download.")
 

digitalhub/stores/data/remote/store.py

@@ -28,7 +28,6 @@ class RemoteStore(Store):
         self,
         root: str,
         dst: Path,
-        src: list[str],
         overwrite: bool = False,
     ) -> str:
         """
@@ -36,19 +35,17 @@ class RemoteStore(Store):
 
         Parameters
         ----------
-        root : str
-            The root path of the artifact.
+        src : str
+            Path of the material entity.
         dst : str
-            The destination of the artifact on local filesystem.
-        src : list[str]
-            List of sources.
+            The destination of the material entity on local filesystem.
         overwrite : bool
             Specify if overwrite existing file(s).
 
         Returns
         -------
         str
-            Destination path of the downloaded artifact.
+            Destination path of the downloaded files.
         """
         # Handle destination
         if dst is None: