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

digitalhub/stores/configurator/configurator.py

@@ -1,198 +0,0 @@
-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
-
-
-class EnvConfigurator:
-    """
-    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
-
-    ##############################
-    # 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.
-
-        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.
-        """
-        self._environment = read_env_from_file()
-        return load_from_file(var)
-
-    def write_env(self, key_to_include: list[str] | None = None) -> 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.
-
-        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:
-        """
-        Register a credential value.
-
-        Parameters
-        ----------
-        key : str
-            The key.
-        value : str
-            The value.
-
-        Returns
-        -------
-        None
-        """
-        self._creds_store.set(self._environment, key, value)
-
-    def get_credential(self, key: str) -> dict:
-        """
-        Get single credential value from key.
-
-        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.
-
-        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}
-
-
-# Define global configurator
-configurator = EnvConfigurator()

digitalhub/stores/configurator/credentials_store.py

@@ -1,65 +0,0 @@
-from __future__ import annotations
-
-
-class CredentialsStore:
-    """
-    Credentials store to store and retrieve credentials.
-    """
-
-    def __init__(self) -> None:
-        self._credentials: dict[str, dict] = {}
-
-    def set(self, profile: str, key: str, value: str) -> None:
-        """
-        Set credentials.
-
-        Parameters
-        ----------
-        profile : str
-            The profile of the credentials.
-        key : str
-            The key of the credentials.
-        value : str
-            The value of the credentials.
-
-        Returns
-        -------
-        None
-        """
-        if profile not in self._credentials:
-            self._credentials[profile] = {}
-        self._credentials[profile][key] = value
-
-    def get(self, profile: str, key: str) -> str | None:
-        """
-        Get credentials.
-
-        Parameters
-        ----------
-        profile : str
-            The profile of the credentials.
-        key : str
-            The key of the credentials.
-
-        Returns
-        -------
-        str | None
-            The value of the credentials.
-        """
-        return self._credentials.get(profile, {}).get(key)
-
-    def get_all(self, profile: str) -> dict[str, str]:
-        """
-        Get all credentials.
-
-        Parameters
-        ----------
-        profile : str
-            The profile of the credentials.
-
-        Returns
-        -------
-        dict[str, str]
-            The credentials.
-        """
-        return self._credentials.get(profile, {})

digitalhub/stores/configurator/enums.py

@@ -1,21 +0,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"

digitalhub/stores/configurator/ini_module.py

@@ -1,128 +0,0 @@
-from __future__ import annotations
-
-from configparser import ConfigParser
-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
-ENV_FILE = Path.home() / ".dhcore.ini"
-
-
-def load_file() -> ConfigParser:
-    """
-    Load current credentials set from the .dhcore.ini file.
-
-    Returns
-    -------
-    ConfigParser
-        Credentials set name.
-    """
-    try:
-        file = ConfigParser()
-        file.read(ENV_FILE)
-        return file
-    except Exception as e:
-        raise ClientError(f"Failed to read env file: {e}")
-
-
-def load_from_file(var: str) -> str | None:
-    """
-    Load variable from config file.
-
-    Parameters
-    ----------
-    profile : str
-        Credentials set name.
-    var : str
-        Environment variable name.
-
-    Returns
-    -------
-    str | None
-        Environment variable value.
-    """
-    try:
-        cfg = load_file()
-        profile = cfg["DEFAULT"]["current_environment"]
-        return cfg[profile].get(var)
-    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.
-
-    Parameters
-    ----------
-    creds : dict
-        Credentials.
-    environment : str
-        Credentials set name.
-
-    Returns
-    -------
-    None
-    """
-    try:
-        cfg = load_file()
-
-        sections = cfg.sections()
-        if environment not in sections:
-            cfg.add_section(environment)
-
-        cfg["DEFAULT"]["current_environment"] = environment
-        for k, v in creds.items():
-            cfg[environment][k] = v
-
-        ENV_FILE.touch(exist_ok=True)
-        with open(ENV_FILE, "w") as inifile:
-            cfg.write(inifile)
-
-    except Exception as e:
-        raise ClientError(f"Failed to write env file: {e}")
-
-
-def set_current_env(environment: str) -> None:
-    """
-    Set the current credentials set.
-
-    Parameters
-    ----------
-    environment : str
-        Credentials set name.
-
-    Returns
-    -------
-    None
-    """
-    try:
-        cfg = load_file()
-        cfg["DEFAULT"]["current_environment"] = environment
-        with open(ENV_FILE, "w") as inifile:
-            cfg.write(inifile)
-
-    except Exception as e:
-        raise ClientError(f"Failed to write env file: {e}")
-
-
-def read_env_from_file() -> str | None:
-    """
-    Read the current credentials set from the .dhcore.ini file.
-
-    Returns
-    -------
-    str
-        Credentials set name.
-    """
-    try:
-        cfg = load_file()
-        return cfg["DEFAULT"]["current_environment"]
-    except Exception:
-        return None

digitalhub/stores/data/s3/enums.py

@@ -1,16 +0,0 @@
-from __future__ import annotations
-
-from enum import Enum
-
-
-class S3StoreEnv(Enum):
-    """
-    S3Store environment
-    """
-
-    ENDPOINT_URL = "AWS_ENDPOINT_URL"
-    ACCESS_KEY_ID = "AWS_ACCESS_KEY_ID"
-    SECRET_ACCESS_KEY = "AWS_SECRET_ACCESS_KEY"
-    SESSION_TOKEN = "AWS_SESSION_TOKEN"
-    REGION = "AWS_REGION"
-    SIGNATURE_VERSION = "S3_SIGNATURE_VERSION"

digitalhub/stores/data/sql/enums.py

@@ -1,16 +0,0 @@
-from __future__ import annotations
-
-from enum import Enum
-
-
-class SqlStoreEnv(Enum):
-    """
-    SqlStore environment
-    """
-
-    HOST = "DB_HOST"
-    PORT = "DB_PORT"
-    USERNAME = "DB_USERNAME"
-    PASSWORD = "DB_PASSWORD"
-    DATABASE = "DB_DATABASE"
-    PG_SCHEMA = "DB_SCHEMA"

digitalhub/stores/data/utils.py

@@ -1,34 +0,0 @@
-from __future__ import annotations
-
-from digitalhub.context.api import get_context
-from digitalhub.stores.configurator.configurator import configurator
-from digitalhub.stores.data.enums import StoreEnv
-
-
-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 = configurator.load_var(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