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

digitalhub/stores/credentials/enums.py

@@ -0,0 +1,68 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class CredsOrigin(Enum):
+    """
+    Credential origins for configuration.
+
+    Attributes
+    ----------
+    ENV : str
+        Credentials from environment variables.
+    FILE : str
+        Credentials from configuration file.
+    """
+
+    ENV = "env"
+    FILE = "file"
+
+
+class SetCreds(Enum):
+    """
+    Supported credential environments.
+    """
+
+    DEFAULT = "__default"
+    DH_PROFILE = "DH_NAME"
+
+
+class CredsEnvVar(Enum):
+    """
+    Supported credential environment variables.
+    """
+
+    # 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"
+    S3_CREDENTIALS_EXPIRATION = "AWS_CREDENTIALS_EXPIRATION"
+    S3_PATH_STYLE = "S3_PATH_STYLE"
+
+    # SQL
+    DB_HOST = "DB_HOST"
+    DB_PORT = "DB_PORT"
+    DB_USERNAME = "DB_USERNAME"
+    DB_PASSWORD = "DB_PASSWORD"
+    DB_DATABASE = "DB_DATABASE"
+    DB_PLATFORM = "DB_PLATFORM"
+    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,176 @@
+# 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_file,
+    load_key,
+    load_profile,
+    set_current_profile,
+    write_config,
+)
+from digitalhub.stores.credentials.store import CredentialsStore
+
+
+class CredentialHandler:
+    """
+    Handler for configuring clients and managing credentials.
+
+    Attributes
+    ----------
+    _creds_store : CredentialsStore
+        Store for credentials.
+    _profile : str
+        Current credentials profile name.
+    """
+
+    def __init__(self) -> None:
+        self._creds_store = CredentialsStore()
+        self._profile = self._read_current_profile()
+
+    @staticmethod
+    def _read_current_profile() -> str:
+        """
+        Read the current credentials profile name.
+
+        Returns
+        -------
+        str
+            Name of the credentials profile.
+        """
+        profile = os.getenv(SetCreds.DH_PROFILE.value)
+        if profile is not None:
+            return profile
+        file = load_file()
+        profile = load_profile(file)
+        if profile is not None:
+            return profile
+        return SetCreds.DEFAULT.value
+
+    ##############################
+    # Public methods
+    ##############################
+
+    def set_current_profile(self, creds_set: str) -> None:
+        """
+        Set the current credentials profile name.
+
+        Parameters
+        ----------
+        creds_set : str
+            Name of the credentials profile to set.
+
+        Returns
+        -------
+        None
+        """
+        self._profile = creds_set
+        set_current_profile(creds_set)
+
+    def get_current_profile(self) -> str:
+        """
+        Get the current credentials profile name.
+
+        Returns
+        -------
+        str
+            Name of the current credentials profile.
+        """
+        return self._profile
+
+    def load_from_env(self, vars: list[str]) -> dict:
+        """
+        Load variables from environment.
+
+        Parameters
+        ----------
+        vars : list of str
+            List of environment variable names to load.
+
+        Returns
+        -------
+        dict
+            Dictionary of environment variable values.
+        """
+        return {var: os.getenv(var) for var in vars}
+
+    def load_from_file(self, vars: list[str]) -> dict:
+        """
+        Load variables from credentials config file.
+
+        Parameters
+        ----------
+        vars : list of str
+            List of variable names to load from file.
+
+        Returns
+        -------
+        dict
+            Dictionary of variable values from file.
+        """
+        file = load_file()
+        profile = load_profile(file)
+        if profile is not None:
+            self._profile = profile
+        return {var: load_key(file, self._profile, var) for var in vars}
+
+    def write_env(self, creds: dict) -> None:
+        """
+        Write credentials to the .dhcore file for the current profile.
+
+        Parameters
+        ----------
+        creds : dict
+            Credentials to write.
+
+        Returns
+        -------
+        None
+        """
+        write_config(creds, self._profile)
+
+    ##############################
+    # Credentials store methods
+    ##############################
+
+    def set_credentials(self, origin: str, creds: dict) -> None:
+        """
+        Set credentials for the current profile and origin.
+
+        Parameters
+        ----------
+        origin : str
+            The origin of the credentials ('env' or 'file').
+        creds : dict
+            Credentials to set.
+
+        Returns
+        -------
+        None
+        """
+        self._creds_store.set_credentials(self._profile, origin, creds)
+
+    def get_credentials(self, origin: str) -> dict:
+        """
+        Get credentials for the current profile from the specified origin.
+
+        Parameters
+        ----------
+        origin : str
+            The origin to get credentials from ('env' or 'file').
+
+        Returns
+        -------
+        dict
+            Dictionary of credentials.
+        """
+        return self._creds_store.get_credentials(self._profile, origin)
+
+
+# Define global credential handler
+creds_handler = CredentialHandler()

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

@@ -9,22 +9,23 @@ from pathlib import Path
 
 from digitalhub.utils.exceptions import ClientError
 
-# File where to write DHCORE_ACCESS_TOKEN and DHCORE_REFRESH_TOKEN
-# It's used because we inject the variables in jupyter env,
-# 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
+# File where to write credementials
 ENV_FILE = Path.home() / ".dhcore.ini"
 
 
 def load_file() -> ConfigParser:
     """
-    Load current credentials set from the .dhcore.ini file.
+    Load the credentials configuration from the .dhcore.ini file.
 
     Returns
     -------
     ConfigParser
-        Credentials set name.
+        Parsed configuration file object.
+
+    Raises
+    ------
+    ClientError
+        If the file cannot be read.
     """
     try:
         file = ConfigParser()
@@ -34,45 +35,71 @@ def load_file() -> ConfigParser:
         raise ClientError(f"Failed to read env file: {e}")
 
 
-def load_from_file(var: str) -> str | None:
+def load_profile(file: ConfigParser) -> str | None:
     """
-    Load variable from config file.
+    Load the current credentials profile name from the .dhcore.ini file.
 
     Parameters
     ----------
+    file : ConfigParser
+        Parsed configuration file object.
+
+    Returns
+    -------
+    str or None
+        Name of the credentials profile, or None if not found.
+    """
+    try:
+        return file["DEFAULT"]["current_environment"]
+    except KeyError:
+        return
+
+
+def load_key(file: ConfigParser, profile: str, key: str) -> str | None:
+    """
+    Load a specific key value from the credentials profile in the
+    .dhcore.ini file.
+
+    Parameters
+    ----------
+    file : ConfigParser
+        Parsed configuration file object.
     profile : str
-        Credentials set name.
-    var : str
-        Environment variable name.
+        Name of the credentials profile.
+    key : str
+        Name of the key to retrieve.
 
     Returns
     -------
-    str | None
-        Environment variable value.
+    str or None
+        Value of the key, or None if not found.
     """
     try:
-        cfg = load_file()
-        profile = cfg["DEFAULT"]["current_environment"]
-        return cfg[profile].get(var)
+        return file[profile][key]
     except KeyError:
         return
 
 
 def write_config(creds: dict, environment: str) -> None:
     """
-    Write the env variables to the .dhcore.ini file.
-    It will overwrite any existing env variables.
+    Write credentials to the .dhcore.ini file for the specified environment.
+    Overwrites any existing values for that environment.
 
     Parameters
     ----------
     creds : dict
-        Credentials.
+        Dictionary of credentials to write.
     environment : str
-        Credentials set name.
+        Name of the credentials profile/environment.
 
     Returns
     -------
     None
+
+    Raises
+    ------
+    ClientError
+        If the file cannot be written.
     """
     try:
         cfg = load_file()
@@ -83,7 +110,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:
@@ -93,18 +120,23 @@ def write_config(creds: dict, environment: str) -> None:
         raise ClientError(f"Failed to write env file: {e}")
 
 
-def set_current_env(environment: str) -> None:
+def set_current_profile(environment: str) -> None:
     """
-    Set the current credentials set.
+    Set the current credentials profile in the .dhcore.ini file.
 
     Parameters
     ----------
     environment : str
-        Credentials set name.
+        Name of the credentials profile to set as current.
 
     Returns
     -------
     None
+
+    Raises
+    ------
+    ClientError
+        If the file cannot be written.
     """
     try:
         cfg = load_file()
@@ -118,12 +150,12 @@ def set_current_env(environment: str) -> None:
 
 def read_env_from_file() -> str | None:
     """
-    Read the current credentials set from the .dhcore.ini file.
+    Read the current credentials profile name from the .dhcore.ini file.
 
     Returns
     -------
-    str
-        Credentials set name.
+    str or None
+        Name of the current credentials profile, or None if not found.
     """
     try:
         cfg = load_file()

digitalhub/stores/credentials/store.py

@@ -0,0 +1,81 @@
+# 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:
+    """
+    Store and retrieve credentials for different profiles and origins.
+
+    Attributes
+    ----------
+    _file_creds : dict of str to dict
+        Credentials stored by profile from file origin.
+    _env_creds : dict of str to Any
+        Credentials stored from environment origin.
+    """
+
+    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.
+
+        Parameters
+        ----------
+        profile : str
+            Name of the credentials profile.
+        origin : str
+            Origin of the credentials ('env' or 'file').
+        credentials : dict of str to Any
+            Dictionary of credentials to set.
+
+        Returns
+        -------
+        None
+        """
+        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.
+
+        Parameters
+        ----------
+        profile : str
+            Name of the credentials profile.
+        origin : str
+            Origin of the credentials ('env' or 'file').
+
+        Returns
+        -------
+        dict of str to Any
+            Dictionary of credentials for the 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.
         """
@@ -173,9 +186,14 @@ class Store:
         """
         if not isinstance(path, Path):
             path = Path(path)
-        if path.suffix != "":
-            path = path.parent
-        path.mkdir(parents=True, exist_ok=True)
+        # If the path does not exist, we need to infer if it's a file or directory
+        if path.suffix and not path.name.startswith("."):
+            # Looks like a file, use parent
+            dir_path = path.parent
+        else:
+            # Looks like a directory (even if it contains dots)
+            dir_path = path
+        dir_path.mkdir(parents=True, exist_ok=True)
 
     @staticmethod
     def _build_temp() -> Path:

digitalhub/stores/data/api.py

@@ -6,28 +6,68 @@ 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_store(project: str, uri: str) -> Store:
+def get_default_store(project: str) -> str:
     """
-    Get store instance by URI.
+    Returns the default store URI for a given project.
 
     Parameters
-    ---------
+    ----------
     project : str
-        Project name.
+        The name of the project.
+
+    Returns
+    -------
+    str
+        The default store URI.
+
+    Raises
+    ------
+    ValueError
+        If no default store is found.
+    """
+    var = StoreEnv.DEFAULT_FILES_STORE.value
+
+    context = get_context(project)
+    store = context.config.get(var.lower().replace("dhcore_", ""))
+    if store is not None:
+        return store
+
+    store = creds_handler.load_from_env([var]).get(var)
+    if store is None:
+        store = creds_handler.load_from_file([var]).get(var)
+
+    if store is None or store == "":
+        raise ValueError(
+            "No default store found. "
+            "Please set a default store "
+            f"in your environment (e.g. export {var}=) "
+            " in the .dhcore.ini file "
+            "or set it in project config."
+        )
+    return store
+
+
+def get_store(uri: str) -> Store:
+    """
+    Returns a store instance for the given URI.
+
+    Parameters
+    ----------
     uri : str
-        URI to parse.
-    config : dict
-        Store configuration.
+        The URI to parse.
 
     Returns
     -------
     Store
-        Store instance.
+        The store instance corresponding to the URI.
     """
-    return store_builder.get(project, uri)
+    return store_builder.get(uri)