digitalhub 0.8.0b2__py3-none-any.whl → 0.8.0b4__py3-none-any.whl

digitalhub/__init__.py

@@ -68,14 +68,15 @@ from digitalhub.entities.workflow.crud import (
 )
 
 try:
-    from digitalhub.entities.model.entity.mlflow import from_mlflow_run
+    from digitalhub.entities.model.mlflow.utils import from_mlflow_run
 except ImportError:
     ...
 
-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
+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.builder 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.objects.dhcore import ClientDHCore
-from digitalhub.client.objects.local import ClientLocal
+from digitalhub.client.dhcore.client import ClientDHCore
+from digitalhub.client.local.client import ClientLocal
 
 if typing.TYPE_CHECKING:
-    from digitalhub.client.objects.base import Client
+    from digitalhub.client._base.client import Client
 
 
 class ClientBuilder:

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

@@ -5,11 +5,12 @@ 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.objects.base import Client
+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.utils.exceptions import (
     BackendError,
     BadRequestError,
@@ -24,52 +25,6 @@ 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.
@@ -624,11 +579,16 @@ 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": self._refresh_token,
+            "refresh_token": refresh_token,
         }
         headers = {"Content-Type": "application/x-www-form-urlencoded"}
         r = request("POST", url, data=payload, headers=headers, timeout=60)

digitalhub/client/dhcore/env.py

@@ -0,0 +1,21 @@
+from __future__ import annotations
+
+import os
+
+# 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

digitalhub/client/dhcore/models.py

@@ -0,0 +1,46 @@
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+from digitalhub.client.dhcore.env import FALLBACK_USER
+
+
+class AuthConfig(BaseModel):
+    """Client configuration model."""
+
+    user: str = FALLBACK_USER
+    """Username."""
+
+
+class BasicAuth(AuthConfig):
+    """Basic authentication model."""
+
+    password: str
+    """Basic authentication password."""
+
+
+class ClientParams(AuthConfig):
+    """Client id authentication model."""
+
+    client_id: str = None
+    """OAuth2 client id."""
+
+    client_scecret: str = None
+    """OAuth2 client secret."""
+
+
+class OAuth2TokenAuth(ClientParams):
+    """OAuth2 token authentication model."""
+
+    access_token: str
+    """OAuth2 token."""
+
+    refresh_token: str = None
+    """OAuth2 refresh token."""
+
+
+class TokenExchangeAuth(ClientParams):
+    """Token exchange authentication model."""
+
+    exchange_token: str
+    """Exchange token."""

digitalhub/{utils/env_utils.py → client/dhcore/utils.py}

@@ -6,7 +6,7 @@ import typing
 from digitalhub.client.builder import check_client_exists, get_client
 
 if typing.TYPE_CHECKING:
-    from digitalhub.client.objects.dhcore import ClientDHCore
+    from digitalhub.client.dhcore.client import ClientDHCore
 
 
 def set_dhcore_env(
@@ -109,15 +109,3 @@ def refresh_token() -> None:
     """
     client: ClientDHCore = get_client(local=False)
     client._get_new_access_token()
-
-
-def get_s3_bucket() -> str | None:
-    """
-    Function to get S3 bucket name.
-
-    Returns
-    -------
-    str
-        The S3 bucket name.
-    """
-    return os.getenv("S3_BUCKET_NAME", "datalake")

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

@@ -3,7 +3,7 @@ from __future__ import annotations
 from copy import deepcopy
 from datetime import datetime, timezone
 
-from digitalhub.client.objects.base import Client
+from digitalhub.client._base.client import Client
 from digitalhub.utils.exceptions import BackendError
 
 

digitalhub/context/builder.py

@@ -5,7 +5,7 @@ import typing
 from digitalhub.context.context import Context
 
 if typing.TYPE_CHECKING:
-    from digitalhub.entities.project.entity._base import Project
+    from digitalhub.entities.project._base.entity import Project
 
 
 class ContextBuilder:

digitalhub/context/context.py

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

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

@@ -7,7 +7,7 @@ from typing import Any
 from digitalhub.readers.builder import get_reader_by_engine
 
 if typing.TYPE_CHECKING:
-    from digitalhub.stores.objects.base import Store
+    from digitalhub.stores._base.store import Store
 
 
 class Datastore(metaclass=ABCMeta):

digitalhub/datastores/builder.py

@@ -2,16 +2,16 @@ from __future__ import annotations
 
 import typing
 
-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.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.builder import get_default_store, get_store
 from digitalhub.utils.uri_utils import map_uri_scheme
 
 if typing.TYPE_CHECKING:
-    from digitalhub.datastores.objects.base import Datastore
-    from digitalhub.stores.objects.base import Store
+    from digitalhub.datastores._base.datastore import Datastore
+    from digitalhub.stores._base.store import Store
 
 
 REGISTRY_DATASTORES = {"local": LocalDatastore, "remote": RemoteDatastore, "s3": S3Datastore, "sql": SqlDatastore}

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

@@ -3,7 +3,7 @@ from __future__ import annotations
 from pathlib import Path
 from typing import Any
 
-from digitalhub.datastores.objects.base import Datastore
+from digitalhub.datastores._base.datastore import Datastore
 from digitalhub.readers.builder import get_reader_by_object
 
 

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

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from typing import Any
 
-from digitalhub.datastores.objects.base import Datastore
+from digitalhub.datastores._base.datastore import Datastore
 
 
 class RemoteDatastore(Datastore):

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

@@ -3,7 +3,7 @@ from __future__ import annotations
 from io import BytesIO
 from typing import Any
 
-from digitalhub.datastores.objects.base import Datastore
+from digitalhub.datastores._base.datastore import Datastore
 from digitalhub.readers.builder import get_reader_by_object
 
 

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

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from typing import Any
 
-from digitalhub.datastores.objects.base import Datastore
+from digitalhub.datastores._base.datastore import Datastore
 from digitalhub.readers.builder import get_reader_by_object
 
 

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

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

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

@@ -4,14 +4,14 @@ import typing
 
 from digitalhub.context.builder import get_context
 from digitalhub.entities._base.crud import create_entity_api_ctx, read_entity_api_ctx, update_entity_api_ctx
-from digitalhub.entities._base.entity.base import Entity
+from digitalhub.entities._base.entity.entity import Entity
 from digitalhub.utils.generic_utils import get_timestamp
 
 if typing.TYPE_CHECKING:
     from digitalhub.context.context import Context
-    from digitalhub.entities._base.metadata import Metadata
-    from digitalhub.entities._base.spec.base import Spec
-    from digitalhub.entities._base.status.base import Status
+    from digitalhub.entities._base.entity.metadata import Metadata
+    from digitalhub.entities._base.entity.spec import Spec
+    from digitalhub.entities._base.entity.status import Status
 
 
 class ContextEntity(Entity):

digitalhub/entities/_base/crud.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import typing
 
 from digitalhub.context.builder import get_context
-from digitalhub.entities._base.api import (
+from digitalhub.entities.utils.api import (
     api_base_create,
     api_base_delete,
     api_base_list,
@@ -20,10 +20,10 @@ from digitalhub.entities._base.api import (
     api_ctx_stop,
     api_ctx_update,
 )
-from digitalhub.entities.utils import parse_entity_key
+from digitalhub.entities.utils.utils import parse_entity_key
 
 if typing.TYPE_CHECKING:
-    from digitalhub.client.objects.base import Client
+    from digitalhub.client._base.client import Client
 
 
 def create_entity_api_base(

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

@@ -3,19 +3,20 @@ from __future__ import annotations
 import typing
 from abc import ABCMeta, abstractmethod
 
-from digitalhub.entities._base.base import ModelObj
+from digitalhub.entities._base._base.entity import Base
+from digitalhub.factory.factory import factory
 
 if typing.TYPE_CHECKING:
-    from digitalhub.entities._base.metadata import Metadata
-    from digitalhub.entities._base.spec.base import Spec
-    from digitalhub.entities._base.status.base import Status
+    from digitalhub.entities._base.entity.metadata import Metadata
+    from digitalhub.entities._base.entity.spec import Spec
+    from digitalhub.entities._base.entity.status import Status
 
 
-class Entity(ModelObj, metaclass=ABCMeta):
+class Entity(Base, metaclass=ABCMeta):
     """
     Abstract class for entities.
 
-    An entity is a collection of metadata, specification and status
+    An entity is a collection of metadata, specifications.and status
     representing a variety of objects handled by Digitalhub.
     """
 
@@ -68,7 +69,7 @@ class Entity(ModelObj, metaclass=ABCMeta):
         -------
         None
         """
-        new_obj = self.from_dict(obj)
+        new_obj = factory.build_entity_from_dict(self.kind, obj)
         self.metadata = new_obj.metadata
         self.spec = new_obj.spec
         self.status = new_obj.status
@@ -93,33 +94,6 @@ class Entity(ModelObj, metaclass=ABCMeta):
         """
         return {k: v for k, v in super().to_dict().items() if k in self._obj_attr}
 
-    @classmethod
-    def from_dict(cls, obj: dict, validate: bool = True) -> Entity:
-        """
-        Create a new object from dictionary.
-
-        Parameters
-        ----------
-        obj : dict
-            Dictionary to create object from.
-        validate : bool
-            Flag to indicate if arguments validation against a pydantic schema must be ignored.
-
-        Returns
-        -------
-        Self
-            Self instance.
-        """
-        parsed_dict = cls._parse_dict(obj, validate=validate)
-        return cls(**parsed_dict)
-
-    @staticmethod
-    @abstractmethod
-    def _parse_dict(obj: dict, validate: bool = True) -> dict:
-        """
-        Abstract method to parse dictionary.
-        """
-
     def __repr__(self) -> str:
         """
         Return string representation of the entity object.

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

@@ -1,9 +1,9 @@
 from __future__ import annotations
 
-from digitalhub.entities._base.base import ModelObj
+from digitalhub.entities._base._base.entity import Base
 
 
-class Metadata(ModelObj):
+class Metadata(Base):
     """
     A class representing the metadata of an entity.
     Metadata is a collection of information about an entity thought

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

@@ -2,46 +2,46 @@ from __future__ import annotations
 
 from pydantic import BaseModel
 
-from digitalhub.entities._base.base import ModelObj
+from digitalhub.entities._base._base.entity import Base
 
 
-class Spec(ModelObj):
+class Spec(Base):
     """
-    A class representing the specification of an entity.
-    Specification is a collection of information about an entity
+    A class representing the specifications.of an entity.
+    specifications.is a collection of information about an entity
     thought to be immutable by the user.
     """
 
     @classmethod
     def from_dict(cls, obj: dict) -> Spec:
         """
-        Return entity specification object from dictionary.
+        Return entity specifications.object from dictionary.
 
         Parameters
         ----------
         obj : dict
-            A dictionary containing the attributes of the entity specification.
+            A dictionary containing the attributes of the entity specifications.
 
         Returns
         -------
         EntitySpec
-            An entity specification object.
+            An entity specifications.object.
         """
         return cls(**obj)
 
 
-class SpecParams(BaseModel, extra="ignore"):
+class SpecValidator(BaseModel, extra="ignore"):
     """
     A class representing the parameters of an entity.
     This base class is used to define the parameters of an entity
-    specification and is used to validate the parameters passed
+    specifications.and is used to validate the parameters passed
     to the constructor.
     """
 
 
 class MaterialSpec(Spec):
     """
-    Material specification class.
+    Material specifications.class.
     """
 
     def __init__(self, path: str, **kwargs) -> None:
@@ -49,7 +49,7 @@ class MaterialSpec(Spec):
         self.path = path
 
 
-class MaterialParams(SpecParams):
+class MaterialValidator(SpecValidator):
     """
     Material parameters class.
     """

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

@@ -1,9 +1,9 @@
 from __future__ import annotations
 
-from digitalhub.entities._base.base import ModelObj
+from digitalhub.entities._base._base.entity import Base
 
 
-class Status(ModelObj):
+class Status(Base):
     """
     Base Status class.
     The status class contains information about the state of an entity,