digitalhub 0.7.0b1__tar.gz → 0.8.0__tar.gz

{digitalhub-0.7.0b1 → digitalhub-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: digitalhub
-Version: 0.7.0b1
+Version: 0.8.0
 Summary: Python SDK for Digitalhub
 Author-email: Fondazione Bruno Kessler <dslab@fbk.eu>, Matteo Martini <mmartini@fbk.eu>
 License:                               Apache License
@@ -225,25 +225,42 @@ Keywords: data,dataops,kubernetes
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
-Requires-Dist: digitalhub-core<0.8,>=0.7.0b
-Provides-Extra: all
-Requires-Dist: digitalhub-data<0.8,>=0.7.0b; extra == "all"
-Requires-Dist: digitalhub-ml<0.8,>=0.7.0b; extra == "all"
-Provides-Extra: ml
-Requires-Dist: digitalhub-ml<0.8,>=0.7.0b; extra == "ml"
-Provides-Extra: data
-Requires-Dist: digitalhub-data<0.8,>=0.7.0b; extra == "data"
+Requires-Dist: boto3
+Requires-Dist: pydantic<2
+Requires-Dist: sqlalchemy<2
+Requires-Dist: pyarrow
+Requires-Dist: numpy<2
+Requires-Dist: requests
+Requires-Dist: PyYAML
+Requires-Dist: python-dotenv
+Requires-Dist: GitPython>=3
+Requires-Dist: psycopg2-binary
+Requires-Dist: python-slugify
 Provides-Extra: full
-Requires-Dist: digitalhub-core[full]<0.8,>=0.7.0b; extra == "full"
-Requires-Dist: digitalhub-data[pandas]<0.8,>=0.7.0b; extra == "full"
-Requires-Dist: digitalhub-ml<0.8,>=0.7.0b; extra == "full"
+Requires-Dist: pandas<2.2,>=1.2; extra == "full"
+Requires-Dist: mlflow; extra == "full"
+Provides-Extra: pandas
+Requires-Dist: pandas<2.2,>=1.2; extra == "pandas"
+Provides-Extra: mlflow
+Requires-Dist: mlflow; extra == "mlflow"
+Provides-Extra: dev
+Requires-Dist: black; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: bumpver; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: moto; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: Sphinx>=7; extra == "docs"
+Requires-Dist: pydata-sphinx-theme>=0.15; extra == "docs"
+Requires-Dist: numpydoc>=1.6; extra == "docs"
 
 # Digitalhub Library
 
 The Digitalhub SDK library is used to manage entities and executions in Digitalhub from Python.
 It comes with a suite of tools to help you manage your projects and executions. It exposes CRUD methods to create, read, update and delete entities, and objects methods to excute functions or workflows, collect or store execution results and data.
 
-A more detailed description of the library can be found in the [official documentation](https://scc-digitalhub.github.io/docs/) of Digitalhub.
+A more detailed description of the library can be found in the [official documentation](https://scc-digitalhub.github.io/sdk-docs/).

{digitalhub-0.7.0b1 → digitalhub-0.8.0}/README.md

@@ -3,4 +3,4 @@
 The Digitalhub SDK library is used to manage entities and executions in Digitalhub from Python.
 It comes with a suite of tools to help you manage your projects and executions. It exposes CRUD methods to create, read, update and delete entities, and objects methods to excute functions or workflows, collect or store execution results and data.
 
-A more detailed description of the library can be found in the [official documentation](https://scc-digitalhub.github.io/docs/) of Digitalhub.
+A more detailed description of the library can be found in the [official documentation](https://scc-digitalhub.github.io/sdk-docs/).

digitalhub-0.8.0/digitalhub/__init__.py

@@ -0,0 +1,82 @@
+from digitalhub.entities.artifact.crud import (
+    delete_artifact,
+    get_artifact,
+    get_artifact_versions,
+    import_artifact,
+    list_artifacts,
+    log_artifact,
+    new_artifact,
+    update_artifact,
+)
+from digitalhub.entities.dataitem.crud import (
+    delete_dataitem,
+    get_dataitem,
+    get_dataitem_versions,
+    import_dataitem,
+    list_dataitems,
+    log_dataitem,
+    new_dataitem,
+    update_dataitem,
+)
+from digitalhub.entities.function.crud import (
+    delete_function,
+    get_function,
+    get_function_versions,
+    import_function,
+    list_functions,
+    new_function,
+    update_function,
+)
+from digitalhub.entities.model.crud import (
+    delete_model,
+    get_model,
+    get_model_versions,
+    import_model,
+    list_models,
+    log_model,
+    new_model,
+    update_model,
+)
+from digitalhub.entities.project.crud import (
+    delete_project,
+    get_or_create_project,
+    get_project,
+    import_project,
+    load_project,
+    new_project,
+    update_project,
+)
+from digitalhub.entities.run.crud import delete_run, get_run, import_run, list_runs, new_run, update_run
+from digitalhub.entities.secret.crud import (
+    delete_secret,
+    get_secret,
+    get_secret_versions,
+    import_secret,
+    list_secrets,
+    new_secret,
+    update_secret,
+)
+from digitalhub.entities.task.crud import delete_task, get_task, import_task, list_tasks, new_task, update_task
+from digitalhub.entities.workflow.crud import (
+    delete_workflow,
+    get_workflow,
+    get_workflow_versions,
+    import_workflow,
+    list_workflows,
+    new_workflow,
+    update_workflow,
+)
+
+try:
+    from digitalhub.entities.model.mlflow.utils import from_mlflow_run
+except ImportError:
+    ...
+
+from digitalhub.client.dhcore.utils import refresh_token, set_dhcore_env
+
+# Register entities into registry
+from digitalhub.factory.utils import register_entities, register_runtimes_entities
+from digitalhub.stores.api import set_store
+
+register_entities()
+register_runtimes_entities()

digitalhub-0.8.0/digitalhub/client/_base/client.py

@@ -0,0 +1,56 @@
+from __future__ import annotations
+
+from abc import abstractmethod
+
+
+class Client:
+    """
+    Base Client class interface.
+
+    The client is an interface that handles the CRUD of an object during
+    a session. It manages the creation, reading, updating, deleting and
+    listing of objects and comes into two subclasses: Local and DHCore.
+    """
+
+    @abstractmethod
+    def create_object(self, api: str, obj: dict, **kwargs) -> dict:
+        """
+        Create object method.
+        """
+
+    @abstractmethod
+    def read_object(self, api: str, **kwargs) -> dict:
+        """
+        Read object method.
+        """
+
+    @abstractmethod
+    def update_object(self, api: str, obj: dict, **kwargs) -> dict:
+        """
+        Update object method.
+        """
+
+    @abstractmethod
+    def delete_object(self, api: str, **kwargs) -> dict:
+        """
+        Delete object method.
+        """
+
+    @abstractmethod
+    def list_objects(self, api: str, **kwargs) -> dict:
+        """
+        List objects method.
+        """
+
+    @abstractmethod
+    def list_first_object(self, api: str, **kwargs) -> dict:
+        """
+        Read first object method.
+        """
+
+    @staticmethod
+    @abstractmethod
+    def is_local() -> bool:
+        """
+        Flag to check if client is local.
+        """

digitalhub-0.8.0/digitalhub/client/api.py

@@ -0,0 +1,63 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.client.builder import client_builder
+
+if typing.TYPE_CHECKING:
+    from digitalhub.client._base.client import Client
+
+
+def check_client_exists(local: bool = False) -> bool:
+    """
+    Check if client exists.
+
+    Parameters
+    ----------
+    local : bool
+        Check client existence by local.
+
+    Returns
+    -------
+    bool
+        True if client exists, False otherwise.
+    """
+    if local:
+        return client_builder._local is not None
+    return client_builder._dhcore is not None
+
+
+def build_client(local: bool = False, config: dict | None = None) -> None:
+    """
+    Wrapper around ClientBuilder.build.
+
+    Parameters
+    ----------
+    local : bool
+        Whether to create a local client or not.
+    config : dict
+        DHCore environment configuration.
+
+    Returns
+    -------
+    Client
+        The client instance.
+    """
+    client_builder.build(local, config)
+
+
+def get_client(local: bool = False) -> Client:
+    """
+    Wrapper around ClientBuilder.build.
+
+    Parameters
+    ----------
+    local : bool
+        Whether to create a local client or not.
+
+    Returns
+    -------
+    Client
+        The client instance.
+    """
+    return client_builder.build(local)

digitalhub-0.8.0/digitalhub/client/builder.py

@@ -0,0 +1,50 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.client.dhcore.client import ClientDHCore
+from digitalhub.client.local.client import ClientLocal
+
+if typing.TYPE_CHECKING:
+    from digitalhub.client._base.client import Client
+
+
+class ClientBuilder:
+    """
+    Client builder class.
+
+    This class is used to create two possible client instances:
+    Local and DHCore.
+    It saves the client instances in the class attributes using
+    singleton pattern.
+    """
+
+    def __init__(self) -> None:
+        self._local = None
+        self._dhcore = None
+
+    def build(self, local: bool = False, config: dict | None = None) -> Client:
+        """
+        Method to create a client instance.
+
+        Parameters
+        ----------
+        local : bool
+            Whether to create a local client or not.
+
+        Returns
+        -------
+        Client
+            Returns the client instance.
+        """
+        if local:
+            if self._local is None:
+                self._local = ClientLocal()
+            return self._local
+
+        if self._dhcore is None:
+            self._dhcore = ClientDHCore(config)
+        return self._dhcore
+
+
+client_builder = ClientBuilder()