digitalhub 0.13.0b3__py3-none-any.whl → 0.14.0b0__py3-none-any.whl

digitalhub/stores/data/local/store.py

@@ -4,7 +4,6 @@
 
 from __future__ import annotations
 
-import shutil
 from pathlib import Path
 from typing import Any
 
@@ -180,105 +179,3 @@ class LocalStore(Store):
         reader = get_reader_by_object(df)
         reader.write_df(df, dst, extension=extension, **kwargs)
         return dst
-
-    ##############################
-    # Private I/O methods
-    ##############################
-
-    def _get_src_dst_files(self, src: Path, dst: Path) -> list[str]:
-        """
-        Copy files from source to destination.
-
-        Parameters
-        ----------
-        src : Path
-            The source path.
-        dst : Path
-            The destination path.
-
-        Returns
-        -------
-        list[str]
-            Returns the list of destination and source paths of the
-            copied files.
-        """
-        return [self._get_src_dst_file(i, dst) for i in src.rglob("*") if i.is_file()]
-
-    def _get_src_dst_file(self, src: Path, dst: Path) -> str:
-        """
-        Copy file from source to destination.
-
-        Parameters
-        ----------
-        src : Path
-            The source path.
-        dst : Path
-            The destination path.
-
-        Returns
-        -------
-        str
-        """
-        dst_pth = self._copy_file(src, dst, True)
-        return str(dst_pth), str(src)
-
-    def _copy_dir(self, src: Path, dst: Path, overwrite: bool) -> list[str]:
-        """
-        Download file from source to destination.
-
-        Parameters
-        ----------
-        src : Path
-            The source path.
-        dst : Path
-            The destination path.
-
-        Returns
-        -------
-        list[str]
-        """
-        dst = self._rebuild_path(dst, src)
-        shutil.copytree(src, dst, dirs_exist_ok=overwrite)
-        return [str(i) for i in dst.rglob("*") if i.is_file()]
-
-    def _copy_file(self, src: Path, dst: Path, overwrite: bool) -> str:
-        """
-        Copy file from source to destination.
-
-        Parameters
-        ----------
-        src : Path
-            The source path.
-        dst : Path
-            The destination path.
-
-        Returns
-        -------
-        str
-        """
-        dst = self._rebuild_path(dst, src)
-        self._check_overwrite(dst, overwrite)
-        return str(shutil.copy2(src, dst))
-
-    def _rebuild_path(self, dst: Path, src: Path) -> Path:
-        """
-        Rebuild path.
-
-        Parameters
-        ----------
-        dst : Path
-            The destination path.
-        src : Path
-            The source path.
-
-        Returns
-        -------
-        Path
-            The rebuilt path.
-        """
-        if dst.is_dir():
-            if src.is_absolute():
-                raise StoreError("Source must be a relative path if the destination is a directory.")
-            dst = dst / src
-        self._build_path(dst)
-        return dst

digitalhub/stores/data/s3/configurator.py

@@ -74,12 +74,23 @@ class S3StoreConfigurator(Configurator):
         dict
             Dictionary containing S3 credentials and configuration.
         """
-        creds = self.get_credentials(self._origin)
-        expired = creds[CredsEnvVar.S3_CREDENTIALS_EXPIRATION.value]
-        if self._origin == self._file and self._is_expired(expired):
-            refresh_token()
-            self.load_file_vars()
-            creds = self.get_credentials(self._origin)
+        creds = self.evaluate_credentials()
+        return self.get_creds_dict(creds)
+
+    def get_creds_dict(self, creds: dict) -> dict:
+        """
+        Returns a dictionary containing the S3 credentials.
+
+        Parameters
+        ----------
+        creds : dict
+            The credentials dictionary.
+
+        Returns
+        -------
+        dict
+            A dictionary containing the S3 credentials.
+        """
         return {
             "endpoint_url": creds[CredsEnvVar.S3_ENDPOINT_URL.value],
             "aws_access_key_id": creds[CredsEnvVar.S3_ACCESS_KEY_ID.value],
@@ -91,6 +102,49 @@ class S3StoreConfigurator(Configurator):
             ),
         }
 
+    def evaluate_credentials(self) -> dict:
+        """
+        Evaluates and returns the current valid credentials.
+        If the credentials are expired and were loaded from file,
+        it refreshes them.
+
+        Returns
+        -------
+        dict
+            The current valid credentials.
+        """
+        creds = self.get_credentials(self._origin)
+        expired = creds[CredsEnvVar.S3_CREDENTIALS_EXPIRATION.value]
+        if self._origin == self._file and self._is_expired(expired):
+            refresh_token()
+            self.load_file_vars()
+            creds = self.get_credentials(self._origin)
+        return creds
+
+    def get_file_config(self) -> dict:
+        """
+        Returns the credentials loaded from file.
+
+        Returns
+        -------
+        dict
+            The credentials loaded from file.
+        """
+        creds = self.get_credentials(self._file)
+        return self.get_creds_dict(creds)
+
+    def get_env_config(self) -> dict:
+        """
+        Returns the credentials loaded from environment variables.
+
+        Returns
+        -------
+        dict
+            The credentials loaded from environment variables.
+        """
+        creds = self.get_credentials(self._env)
+        return self.get_creds_dict(creds)
+
     @staticmethod
     def _is_expired(timestamp: str | None) -> bool:
         """

digitalhub/stores/data/s3/store.py

@@ -16,7 +16,6 @@ from boto3.s3.transfer import TransferConfig
 from botocore.exceptions import ClientError, NoCredentialsError
 
 from digitalhub.stores.data._base.store import Store
-from digitalhub.stores.data.s3.utils import get_bucket_name
 from digitalhub.stores.readers.data.api import get_reader_by_object
 from digitalhub.utils.exceptions import ConfigError, StoreError
 from digitalhub.utils.file_utils import get_file_info_from_s3, get_file_mime_type
@@ -337,6 +336,49 @@ class S3Store(Store):
         reader.write_df(df, fileobj, extension=extension, **kwargs)
         return self.upload_fileobject(fileobj, dst)
 
+    ##############################
+    # Wrapper methods
+    ##############################
+
+    def get_s3_source(self, src: str, filename: Path) -> None:
+        """
+        Download a file from S3 and save it to a local file.
+
+        Parameters
+        ----------
+        src : str
+            S3 path of the object to be downloaded (e.g., 's3://bucket
+        filename : Path
+            Local path where the downloaded object will be saved.
+
+        Returns
+        -------
+        None
+        """
+        client, bucket = self._check_factory(src)
+        key = self._get_key(src)
+        self._download_file(key, filename, client, bucket)
+
+    def get_s3_client(self, file: bool = True) -> S3Client:
+        """
+        Get an S3 client object.
+
+        Parameters
+        ----------
+        file : bool
+            Whether to use file-based credentials. Default is True.
+
+        Returns
+        -------
+        S3Client
+            Returns a client object that interacts with the S3 storage service.
+        """
+        if file:
+            cfg = self._configurator.get_file_config()
+        else:
+            cfg = self._configurator.get_env_config()
+        return self._get_client(cfg)
+
     ##############################
     # Private I/O methods
     ##############################
@@ -595,7 +637,7 @@ class S3Store(Store):
         str
             The name of the S3 bucket.
         """
-        return get_bucket_name(root)
+        return urlparse(root).netloc
 
     def _get_client(self, cfg: dict) -> S3Client:
         """

digitalhub/stores/data/sql/configurator.py

@@ -10,8 +10,19 @@ from digitalhub.stores.credentials.enums import CredsEnvVar
 
 class SqlStoreConfigurator(Configurator):
     """
-    Configure the store by getting the credentials from user
-    provided config or from environment.
+    SQL store configuration manager for database connections.
+
+    Handles credential management and configuration for SQL database
+    connections. Loads credentials from environment variables or
+    configuration files and provides connection string generation
+    for database access.
+
+    Attributes
+    ----------
+    keys : list[str]
+        List of all supported credential keys for SQL connections.
+    required_keys : list[str]
+        List of mandatory credential keys that must be provided.
     """
 
     keys = [
@@ -40,31 +51,70 @@ class SqlStoreConfigurator(Configurator):
 
     def load_env_vars(self) -> None:
         """
-        Load the credentials from the environment.
+        Load database credentials from environment variables.
+
+        Retrieves SQL database connection credentials from the system
+        environment variables and stores them in the configurator's
+        credential handler for use in database connections.
+
+        Returns
+        -------
+        None
         """
         env_creds = self._creds_handler.load_from_env(self.keys)
         self._creds_handler.set_credentials(self._env, env_creds)
 
     def load_file_vars(self) -> None:
         """
-        Load the credentials from the file.
+        Load database credentials from configuration file.
+
+        Retrieves SQL database connection credentials from a
+        configuration file and stores them in the configurator's
+        credential handler for use in database connections.
+
+        Returns
+        -------
+        None
         """
         file_creds = self._creds_handler.load_from_file(self.keys)
         self._creds_handler.set_credentials(self._file, file_creds)
 
     def get_sql_conn_string(self) -> str:
         """
-        Get the connection string from environment variables.
+        Generate PostgreSQL connection string from stored credentials.
+
+        Constructs a PostgreSQL connection string using the configured
+        database credentials including username, password, host, port,
+        and database name.
 
         Returns
         -------
         str
-            The connection string.
+            A PostgreSQL connection string in the format:
+            'postgresql://username:password@host:port/database'
         """
-        creds = self.get_credentials(self._origin)
+        creds = self.get_sql_credentials()
         user = creds[CredsEnvVar.DB_USERNAME.value]
         password = creds[CredsEnvVar.DB_PASSWORD.value]
         host = creds[CredsEnvVar.DB_HOST.value]
         port = creds[CredsEnvVar.DB_PORT.value]
         database = creds[CredsEnvVar.DB_DATABASE.value]
         return f"postgresql://{user}:{password}@{host}:{port}/{database}"
+
+    def get_sql_credentials(self) -> dict:
+        """
+        Get all configured database credentials as a dictionary.
+
+        Retrieves all available database credentials from the configured
+        source and returns them as a dictionary with all credential keys
+        from self.keys mapped to their values.
+
+        Returns
+        -------
+        dict
+            Dictionary containing all credential key-value pairs from self.keys.
+            Keys correspond to database connection parameters such as
+            username, password, host, port, database, and platform.
+        """
+        creds = self.get_credentials(self._origin)
+        return {key: creds.get(key) for key in self.keys}