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

digitalhub/stores/data/sql/configurator.py

@@ -1,29 +1,51 @@
+# 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.configurator.enums import CredsOrigin
-from digitalhub.stores.data.sql.enums import SqlStoreEnv
-from digitalhub.utils.exceptions import StoreError
+from digitalhub.stores.credentials.configurator import Configurator
+from digitalhub.stores.credentials.enums import CredsEnvVar
 
 
-class SqlStoreConfigurator:
+class SqlStoreConfigurator(Configurator):
     """
     Configure the store by getting the credentials from user
     provided config or from environment.
     """
 
-    required_vars = [
-        SqlStoreEnv.USERNAME,
-        SqlStoreEnv.PASSWORD,
-        SqlStoreEnv.HOST,
-        SqlStoreEnv.PORT,
-        SqlStoreEnv.DATABASE,
+    keys = [
+        CredsEnvVar.DB_USERNAME,
+        CredsEnvVar.DB_PASSWORD,
+        CredsEnvVar.DB_HOST,
+        CredsEnvVar.DB_PORT,
+        CredsEnvVar.DB_DATABASE,
+    ]
+    required_keys = [
+        CredsEnvVar.DB_USERNAME,
+        CredsEnvVar.DB_PASSWORD,
+        CredsEnvVar.DB_HOST,
+        CredsEnvVar.DB_PORT,
+        CredsEnvVar.DB_DATABASE,
     ]
 
+    def __init__(self):
+        super().__init__()
+        self.load_configs()
+
     ##############################
     # Configuration methods
     ##############################
 
+    def load_configs(self) -> None:
+        # Load from env
+        env_creds = {var.value: self._creds_handler.load_from_env(var.value) for var in self.keys}
+        self._creds_handler.set_credentials(self._env, env_creds)
+
+        # Load from file
+        file_creds = {var.value: self._creds_handler.load_from_file(var.value) for var in self.keys}
+        self._creds_handler.set_credentials(self._file, file_creds)
+
     def get_sql_conn_string(self, origin: str) -> str:
         """
         Get the connection string from environment variables.
@@ -38,76 +60,10 @@ class SqlStoreConfigurator:
         str
             The connection string.
         """
-        if origin == CredsOrigin.ENV.value:
-            creds = self._get_env_config()
-        elif origin == CredsOrigin.FILE.value:
-            creds = self._get_file_config()
-        else:
-            raise StoreError(f"Unknown origin: {origin}")
-
-        user = creds[SqlStoreEnv.USERNAME.value]
-        password = creds[SqlStoreEnv.PASSWORD.value]
-        host = creds[SqlStoreEnv.HOST.value]
-        port = creds[SqlStoreEnv.PORT.value]
-        database = creds[SqlStoreEnv.DATABASE.value]
+        creds = self.get_credentials(origin)
+        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_env_config(self) -> dict:
-        """
-        Get the store configuration from environment variables.
-
-        Returns
-        -------
-        dict
-            The credentials.
-        """
-        credentials = {var.value: configurator.load_from_env(var.value) for var in self.required_vars}
-        self._set_credentials(credentials)
-        return credentials
-
-    def _get_file_config(self) -> dict:
-        """
-        Get the store configuration from file.
-
-        Returns
-        -------
-        dict
-            The credentials.
-        """
-        credentials = {var.value: configurator.load_from_file(var.value) for var in self.required_vars}
-        self._set_credentials(credentials)
-        return credentials
-
-    def _check_credentials(self, credentials: dict) -> None:
-        """
-        Check for missing credentials.
-
-        Parameters
-        ----------
-        credentials : dict
-            The credentials.
-
-        Returns
-        -------
-        None
-        """
-        missing_vars = [key for key, value in credentials.items() if value is None and key in self.required_vars]
-        if missing_vars:
-            raise StoreError(f"Missing credentials for SQL store: {', '.join(missing_vars)}")
-
-    def _set_credentials(self, credentials: dict) -> None:
-        """
-        Set the store credentials into the configurator.
-
-        Parameters
-        ----------
-        credentials : dict
-            The credentials.
-
-        Returns
-        -------
-        None
-        """
-        # Set credentials
-        for key, value in credentials.items():
-            configurator.set_credential(key, value)

digitalhub/stores/data/sql/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
@@ -10,9 +14,8 @@ from sqlalchemy import MetaData, Table, create_engine, select
 from sqlalchemy.engine import Engine
 from sqlalchemy.exc import SQLAlchemyError
 
-from digitalhub.stores.configurator.enums import CredsOrigin
+from digitalhub.stores.credentials.enums import CredsOrigin
 from digitalhub.stores.data._base.store import Store
-from digitalhub.stores.data.sql.configurator import SqlStoreConfigurator
 from digitalhub.stores.readers.data.api import get_reader_by_object
 from digitalhub.utils.exceptions import StoreError
 from digitalhub.utils.types import SourcesOrListOfSources
@@ -20,6 +23,9 @@ from digitalhub.utils.types import SourcesOrListOfSources
 if typing.TYPE_CHECKING:
     from sqlalchemy.engine.row import Row
 
+    from digitalhub.stores.credentials.configurator import Configurator
+    from digitalhub.stores.data.sql.configurator import SqlStoreConfigurator
+
 
 class SqlStore(Store):
     """
@@ -27,8 +33,9 @@ class SqlStore(Store):
     artifacts on SQL based storage.
     """
 
-    def __init__(self) -> None:
-        self._configurator = SqlStoreConfigurator()
+    def __init__(self, configurator: Configurator | None = None) -> None:
+        super().__init__(configurator)
+        self._configurator: SqlStoreConfigurator
 
     ##############################
     # I/O methods
@@ -36,9 +43,8 @@ class SqlStore(Store):
 
     def download(
         self,
-        root: str,
+        src: str,
         dst: Path,
-        src: list[str],
         overwrite: bool = False,
     ) -> str:
         """
@@ -46,21 +52,19 @@ class SqlStore(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.
         """
-        table_name = self._get_table_name(root) + ".parquet"
+        table_name = self._get_table_name(src) + ".parquet"
         # Case where dst is not provided
         if dst is None:
             dst = Path(self._build_temp("sql")) / table_name
@@ -79,8 +83,8 @@ class SqlStore(Store):
             self._check_overwrite(dst, overwrite)
             self._build_path(dst)
 
-        schema = self._get_schema(root)
-        table = self._get_table_name(root)
+        schema = self._get_schema(src)
+        table = self._get_table_name(src)
         return self._download_table(schema, table, str(dst))
 
     def upload(

digitalhub/stores/readers/__init__.py

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

digitalhub/stores/readers/data/__init__.py

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

digitalhub/stores/readers/data/_base/__init__.py

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

digitalhub/stores/readers/data/_base/builder.py

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

digitalhub/stores/readers/data/_base/reader.py

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

digitalhub/stores/readers/data/api.py

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

digitalhub/stores/readers/data/factory.py

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

digitalhub/stores/readers/data/pandas/__init__.py

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

digitalhub/stores/readers/data/pandas/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.readers.data._base.builder import ReaderBuilder

digitalhub/stores/readers/data/pandas/reader.py

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

digitalhub/stores/readers/query/__init__.py

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

digitalhub/utils/__init__.py

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

digitalhub/utils/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/utils/exceptions.py

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

digitalhub/utils/file_utils.py

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

digitalhub/utils/generic_utils.py

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

digitalhub/utils/git_utils.py

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

digitalhub/utils/io_utils.py

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

digitalhub/utils/logger.py

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

digitalhub/utils/types.py

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

digitalhub/utils/uri_utils.py

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