digitalhub 0.8.0__py3-none-any.whl → 0.8.0b1__py3-none-any.whl

digitalhub/__init__.py

@@ -68,15 +68,14 @@ from digitalhub.entities.workflow.crud import (
 )
 
 try:
-    from digitalhub.entities.model.mlflow.utils import from_mlflow_run
+    from digitalhub.entities.model.entity.mlflow import from_mlflow_run
 except ImportError:
     ...
 
-from digitalhub.client.dhcore.utils import refresh_token, set_dhcore_env
+from digitalhub.registry.utils import register_entities, register_runtimes_entities
+from digitalhub.stores.builder import set_store
+from digitalhub.utils.env_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/client/builder.py

@@ -2,11 +2,11 @@ from __future__ import annotations
 
 import typing
 
-from digitalhub.client.dhcore.client import ClientDHCore
-from digitalhub.client.local.client import ClientLocal
+from digitalhub.client.objects.dhcore import ClientDHCore
+from digitalhub.client.objects.local import ClientLocal
 
 if typing.TYPE_CHECKING:
-    from digitalhub.client._base.client import Client
+    from digitalhub.client.objects.base import Client
 
 
 class ClientBuilder:
@@ -47,4 +47,59 @@ class ClientBuilder:
         return self._dhcore
 
 
+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)
+
+
+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 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
+
+
 client_builder = ClientBuilder()

digitalhub/client/{dhcore/client.py → objects/dhcore.py}

@@ -1,18 +1,15 @@
 from __future__ import annotations
 
-import datetime
-import json
 import os
 import typing
 from urllib.parse import urlparse
 
 from dotenv import load_dotenv, set_key
+from pydantic import BaseModel
 from requests import request
 from requests.exceptions import HTTPError, JSONDecodeError, RequestException
 
-from digitalhub.client._base.client import Client
-from digitalhub.client.dhcore.env import ENV_FILE, FALLBACK_USER, MAX_API_LEVEL, MIN_API_LEVEL
-from digitalhub.client.dhcore.models import BasicAuth, OAuth2TokenAuth
+from digitalhub.client.objects.base import Client
 from digitalhub.utils.exceptions import (
     BackendError,
     BadRequestError,
@@ -27,6 +24,52 @@ if typing.TYPE_CHECKING:
     from requests import Response
 
 
+# Use env user as fallback in the API calls
+try:
+    FALLBACK_USER = os.getlogin()
+except Exception:
+    FALLBACK_USER = None
+
+# 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 = ".dhcore"
+
+
+# API levels that are supported
+MAX_API_LEVEL = 20
+MIN_API_LEVEL = 8
+
+
+class AuthConfig(BaseModel):
+    """Client configuration model."""
+
+    user: str = FALLBACK_USER
+    """Username."""
+
+
+class OAuth2TokenAuth(AuthConfig):
+    """OAuth2 token authentication model."""
+
+    access_token: str
+    """OAuth2 token."""
+
+    refresh_token: str = None
+    """OAuth2 refresh token."""
+
+    client_id: str = None
+    """OAuth2 client id."""
+
+
+class BasicAuth(AuthConfig):
+    """Basic authentication model."""
+
+    password: str
+    """Basic authentication password."""
+
+
 class ClientDHCore(Client):
     """
     DHCore client.
@@ -85,10 +128,7 @@ class ClientDHCore(Client):
         dict
             Response object.
         """
-        if "headers" not in kwargs:
-            kwargs["headers"] = {}
-        kwargs["headers"]["Content-Type"] = "application/json"
-        kwargs["data"] = json.dumps(obj, default=ClientDHCore._json_serialize)
+        kwargs["json"] = obj
         return self._prepare_call("POST", api, **kwargs)
 
     def read_object(self, api: str, **kwargs) -> dict:
@@ -127,10 +167,7 @@ class ClientDHCore(Client):
         dict
             Response object.
         """
-        if "headers" not in kwargs:
-            kwargs["headers"] = {}
-        kwargs["headers"]["Content-Type"] = "application/json"
-        kwargs["data"] = json.dumps(obj, default=ClientDHCore._json_serialize)
+        kwargs["json"] = obj
         return self._prepare_call("PUT", api, **kwargs)
 
     def delete_object(self, api: str, **kwargs) -> dict:
@@ -173,7 +210,7 @@ class ClientDHCore(Client):
         if kwargs is None:
             kwargs = {}
 
-        if "params" not in kwargs:
+        if kwargs.get("params") is None:
             kwargs["params"] = {}
 
         start_page = 0
@@ -211,31 +248,12 @@ class ClientDHCore(Client):
         try:
             return self.list_objects(api, **kwargs)[0]
         except IndexError:
-            raise BackendError("No object found.")
+            raise IndexError("No objects found")
 
     ##############################
     # Call methods
     ##############################
 
-    @staticmethod
-    def _json_serialize(obj: dict) -> dict:
-        """
-        JSON datetime to ISO format serializer.
-
-        Parameters
-        ----------
-        obj : dict
-            The object to serialize.
-
-        Returns
-        -------
-        dict
-            The serialized object.
-        """
-        if isinstance(obj, (datetime.datetime, datetime.date)):
-            return obj.isoformat()
-        raise TypeError("Type %s not serializable" % type(obj))
-
     def _prepare_call(self, call_type: str, api: str, **kwargs) -> dict:
         """
         Prepare a call to the DHCore API.
@@ -257,12 +275,12 @@ class ClientDHCore(Client):
         if kwargs is None:
             kwargs = {}
         url = self._endpoint_core + api
-        kwargs = self._set_auth(kwargs)
+        kwargs = self._set_auth_header(kwargs)
         return self._make_call(call_type, url, **kwargs)
 
-    def _set_auth(self, kwargs: dict) -> dict:
+    def _set_auth_header(self, kwargs: dict) -> dict:
         """
-        Set the authentication type.
+        Set the authentication header.
 
         Parameters
         ----------
@@ -272,14 +290,13 @@ class ClientDHCore(Client):
         Returns
         -------
         dict
-            Keyword arguments with the authentication parameters.
+            Keyword arguments with the authentication header.
         """
         if self._auth_type == "basic":
             kwargs["auth"] = self._user, self._password
         elif self._auth_type == "oauth2":
-            if "headers" not in kwargs:
-                kwargs["headers"] = {}
-            kwargs["headers"]["Authorization"] = f"Bearer {self._access_token}"
+            kwargs["headers"] = {"Authorization": f"Bearer {self._access_token}"}
+
         return kwargs
 
     def _make_call(self, call_type: str, url: str, refresh_token: bool = True, **kwargs) -> dict:
@@ -309,7 +326,7 @@ class ClientDHCore(Client):
         # Handle token refresh
         if response.status_code in [401] and refresh_token:
             self._get_new_access_token()
-            kwargs = self._set_auth(kwargs)
+            kwargs = self._set_auth_header(kwargs)
             return self._make_call(call_type, url, refresh_token=False, **kwargs)
 
         self._raise_for_error(response)
@@ -607,16 +624,11 @@ class ClientDHCore(Client):
         dict
             Response object.
         """
-        # Get refersh token from .core file to avoid concurrency
-        # in a shared workspace
-        self._load_env()
-        refresh_token = os.getenv("DHCORE_REFRESH_TOKEN")
-
         # Send request to get new access token
         payload = {
             "grant_type": "refresh_token",
             "client_id": self._client_id,
-            "refresh_token": refresh_token,
+            "refresh_token": self._refresh_token,
         }
         headers = {"Content-Type": "application/x-www-form-urlencoded"}
         r = request("POST", url, data=payload, headers=headers, timeout=60)

digitalhub/client/{local/client.py → objects/local.py}

@@ -3,7 +3,7 @@ from __future__ import annotations
 from copy import deepcopy
 from datetime import datetime, timezone
 
-from digitalhub.client._base.client import Client
+from digitalhub.client.objects.base import Client
 from digitalhub.utils.exceptions import BackendError
 
 
@@ -470,7 +470,7 @@ class ClientLocal(Client):
                     copied = deepcopy(entity)
 
                     # Remove spec if not embedded
-                    if not copied.get("metadata", {}).get("embedded", False):
+                    if not copied.get("metadata", {}).get("embedded", True):
                         copied.pop("spec", None)
 
                     # Add to project spec

digitalhub/context/builder.py

@@ -5,7 +5,7 @@ import typing
 from digitalhub.context.context import Context
 
 if typing.TYPE_CHECKING:
-    from digitalhub.entities.project._base.entity import Project
+    from digitalhub.entities.project.entity._base import Project
 
 
 class ContextBuilder:
@@ -91,4 +91,88 @@ class ContextBuilder:
         self._instances[context.name] = context
 
 
+def set_context(project: Project) -> None:
+    """
+    Wrapper for ContextBuilder.build().
+
+    Parameters
+    ----------
+    project : Project
+        The project object used to set the current context.
+
+    Returns
+    -------
+    None
+    """
+    context_builder.build(project)
+
+
+def set_context_object(context: Context) -> None:
+    """
+    Wrapper for ContextBuilder.set().
+
+    Parameters
+    ----------
+    context : Context
+        The context to set.
+
+    Returns
+    -------
+    None
+    """
+    context_builder.set(context)
+
+
+def get_context(project: str) -> Context:
+    """
+    Wrapper for ContextBuilder.get().
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+
+    Returns
+    -------
+    Context
+        The context for the given project name.
+    """
+    return context_builder.get(project)
+
+
+def delete_context(project: str) -> None:
+    """
+    Wrapper for ContextBuilder.remove().
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+
+    Returns
+    -------
+    None
+    """
+    context_builder.remove(project)
+
+
+def check_context(project: str) -> None:
+    """
+    Check if the given project is in the context.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+
+    Returns
+    -------
+    bool
+        True if the project is in the context, False otherwise.
+    """
+    if project not in context_builder._instances:
+        msg = f"Context missing. Set context by creating or importing a project named '{project}'."
+        raise RuntimeError(msg)
+
+
 context_builder = ContextBuilder()

digitalhub/context/context.py

@@ -4,7 +4,7 @@ import typing
 from pathlib import Path
 
 if typing.TYPE_CHECKING:
-    from digitalhub.entities.project._base.entity import Project
+    from digitalhub.entities.project.entity._base import Project
 
 
 class Context:

digitalhub/datastores/builder.py

@@ -2,24 +2,19 @@ from __future__ import annotations
 
 import typing
 
-from digitalhub.datastores.local.datastore import LocalDatastore
-from digitalhub.datastores.remote.datastore import RemoteDatastore
-from digitalhub.datastores.s3.datastore import S3Datastore
-from digitalhub.datastores.sql.datastore import SqlDatastore
-from digitalhub.stores.api import get_default_store, get_store
+from digitalhub.datastores.objects.local import LocalDatastore
+from digitalhub.datastores.objects.remote import RemoteDatastore
+from digitalhub.datastores.objects.s3 import S3Datastore
+from digitalhub.datastores.objects.sql import SqlDatastore
+from digitalhub.stores.builder import get_default_store, get_store
 from digitalhub.utils.uri_utils import map_uri_scheme
 
 if typing.TYPE_CHECKING:
-    from digitalhub.datastores._base.datastore import Datastore
-    from digitalhub.stores._base.store import Store
+    from digitalhub.datastores.objects.base import Datastore
+    from digitalhub.stores.objects.base import Store
 
 
-REGISTRY_DATASTORES = {
-    "local": LocalDatastore,
-    "remote": RemoteDatastore,
-    "s3": S3Datastore,
-    "sql": SqlDatastore,
-}
+REGISTRY_DATASTORES = {"local": LocalDatastore, "remote": RemoteDatastore, "s3": S3Datastore, "sql": SqlDatastore}
 
 
 class DatastoreBuilder:
@@ -108,3 +103,32 @@ class DatastoreBuilder:
 
 
 builder = DatastoreBuilder()
+
+
+def get_datastore(uri: str) -> Datastore:
+    """
+    Get a datastore instance by URI.
+
+    Parameters
+    ----------
+    uri : str
+        URI to parse.
+
+    Returns
+    -------
+    Datastore
+        The datastore instance.
+    """
+    return builder.get(uri)
+
+
+def get_default_datastore() -> Datastore:
+    """
+    Get the default datastore instance.
+
+    Returns
+    -------
+    Datastore
+        The default datastore instance.
+    """
+    return builder.default()

digitalhub/datastores/{_base/datastore.py → objects/base.py}

@@ -4,10 +4,10 @@ import typing
 from abc import ABCMeta, abstractmethod
 from typing import Any
 
-from digitalhub.readers.api import get_reader_by_engine
+from digitalhub.readers.builder import get_reader_by_engine
 
 if typing.TYPE_CHECKING:
-    from digitalhub.stores._base.store import Store
+    from digitalhub.stores.objects.base import Store
 
 
 class Datastore(metaclass=ABCMeta):
@@ -32,7 +32,7 @@ class Datastore(metaclass=ABCMeta):
         self,
         path: str | list[str],
         extension: str,
-        engine: str | None = None,
+        engine: str | None = "pandas",
         **kwargs,
     ) -> Any:
         """

digitalhub/datastores/{local/datastore.py → objects/local.py}

@@ -1,14 +1,10 @@
 from __future__ import annotations
 
-import typing
 from pathlib import Path
 from typing import Any
 
-from digitalhub.datastores._base.datastore import Datastore
-from digitalhub.readers.api import get_reader_by_object
-
-if typing.TYPE_CHECKING:
-    from digitalhub.stores.local.store import LocalStore
+from digitalhub.datastores.objects.base import Datastore
+from digitalhub.readers.builder import get_reader_by_object
 
 
 class LocalDatastore(Datastore):
@@ -16,10 +12,6 @@ class LocalDatastore(Datastore):
     Local Datastore class.
     """
 
-    def __init__(self, store: LocalStore, **kwargs) -> None:
-        super().__init__(store, **kwargs)
-        self.store: LocalStore
-
     def write_df(self, df: Any, dst: str, extension: str | None = None, **kwargs) -> str:
         """
         Method to write a dataframe to a file. Kwargs are passed to df.to_parquet().

digitalhub/datastores/{remote/datastore.py → objects/remote.py}

@@ -1,12 +1,8 @@
 from __future__ import annotations
 
-import typing
 from typing import Any
 
-from digitalhub.datastores._base.datastore import Datastore
-
-if typing.TYPE_CHECKING:
-    from digitalhub.stores.remote.store import RemoteStore
+from digitalhub.datastores.objects.base import Datastore
 
 
 class RemoteDatastore(Datastore):
@@ -14,10 +10,6 @@ class RemoteDatastore(Datastore):
     Remote Datastore class.
     """
 
-    def __init__(self, store: RemoteStore, **kwargs) -> None:
-        super().__init__(store, **kwargs)
-        self.store: RemoteStore
-
     def write_df(self, df: Any, dst: str, extension: str | None = None, **kwargs) -> str:
         """
         Method to write a dataframe to a file. Note that this method is not implemented

digitalhub/datastores/{s3/datastore.py → objects/s3.py}

@@ -1,14 +1,10 @@
 from __future__ import annotations
 
-import typing
 from io import BytesIO
 from typing import Any
 
-from digitalhub.datastores._base.datastore import Datastore
-from digitalhub.readers.api import get_reader_by_object
-
-if typing.TYPE_CHECKING:
-    from digitalhub.stores.s3.store import S3Store
+from digitalhub.datastores.objects.base import Datastore
+from digitalhub.readers.builder import get_reader_by_object
 
 
 class S3Datastore(Datastore):
@@ -16,10 +12,6 @@ class S3Datastore(Datastore):
     S3 Datastore class.
     """
 
-    def __init__(self, store: S3Store, **kwargs) -> None:
-        super().__init__(store, **kwargs)
-        self.store: S3Store
-
     def write_df(self, df: Any, dst: str, extension: str | None = None, **kwargs) -> str:
         """
         Write a dataframe to S3 based storage. Kwargs are passed to df.to_parquet().

digitalhub/datastores/{sql/datastore.py → objects/sql.py}

@@ -1,13 +1,9 @@
 from __future__ import annotations
 
-import typing
 from typing import Any
 
-from digitalhub.datastores._base.datastore import Datastore
-from digitalhub.readers.api import get_reader_by_object
-
-if typing.TYPE_CHECKING:
-    from digitalhub.stores.sql.store import SqlStore
+from digitalhub.datastores.objects.base import Datastore
+from digitalhub.readers.builder import get_reader_by_object
 
 
 class SqlDatastore(Datastore):
@@ -15,10 +11,6 @@ class SqlDatastore(Datastore):
     Sql Datastore class.
     """
 
-    def __init__(self, store: SqlStore, **kwargs) -> None:
-        super().__init__(store, **kwargs)
-        self.store: SqlStore
-
     def write_df(self, df: Any, dst: str, extension: str | None = None, **kwargs) -> str:
         """
         Write a dataframe to a database. Kwargs are passed to df.to_sql().

digitalhub/entities/_base/{_base/entity.py → base.py}

@@ -3,7 +3,7 @@ from __future__ import annotations
 from digitalhub.utils.generic_utils import dict_to_json
 
 
-class Base:
+class ModelObj:
     """
     Base class for all entities.
     It implements to_dict abd to_json method to represent