digitalhub 0.8.0b6__py3-none-any.whl → 0.8.0b10__py3-none-any.whl

digitalhub/__init__.py

@@ -76,7 +76,7 @@ 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
+from digitalhub.stores.api import set_store
 
 register_entities()
 register_runtimes_entities()

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/client/builder.py

@@ -47,59 +47,4 @@ 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/utils.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import os
 import typing
 
-from digitalhub.client.builder import check_client_exists, get_client
+from digitalhub.client.api import check_client_exists, get_client
 
 if typing.TYPE_CHECKING:
     from digitalhub.client.dhcore.client import ClientDHCore

digitalhub/context/api.py

@@ -0,0 +1,93 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.context.builder import context_builder
+
+if typing.TYPE_CHECKING:
+    from digitalhub.context.context import Context
+    from digitalhub.entities.project._base.entity import 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)
+
+
+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 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 set_context_object(context: Context) -> None:
+    """
+    Wrapper for ContextBuilder.set().
+
+    Parameters
+    ----------
+    context : Context
+        The context to set.
+
+    Returns
+    -------
+    None
+    """
+    context_builder.set(context)
+
+
+def delete_context(project: str) -> None:
+    """
+    Wrapper for ContextBuilder.remove().
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+
+    Returns
+    -------
+    None
+    """
+    context_builder.remove(project)

digitalhub/context/builder.py

@@ -91,88 +91,4 @@ 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/datastores/_base/datastore.py

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

digitalhub/datastores/api.py

@@ -0,0 +1,37 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.datastores.builder import builder
+
+if typing.TYPE_CHECKING:
+    from digitalhub.datastores._base.datastore import Datastore
+
+
+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/builder.py

@@ -6,7 +6,7 @@ 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.stores.api import get_default_store, get_store
 from digitalhub.utils.uri_utils import map_uri_scheme
 
 if typing.TYPE_CHECKING:
@@ -14,7 +14,12 @@ if typing.TYPE_CHECKING:
     from digitalhub.stores._base.store import Store
 
 
-REGISTRY_DATASTORES = {"local": LocalDatastore, "remote": RemoteDatastore, "s3": S3Datastore, "sql": SqlDatastore}
+REGISTRY_DATASTORES = {
+    "local": LocalDatastore,
+    "remote": RemoteDatastore,
+    "s3": S3Datastore,
+    "sql": SqlDatastore,
+}
 
 
 class DatastoreBuilder:
@@ -103,32 +108,3 @@ 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/local/datastore.py

@@ -1,10 +1,14 @@
 from __future__ import annotations
 
+import typing
 from pathlib import Path
 from typing import Any
 
 from digitalhub.datastores._base.datastore import Datastore
-from digitalhub.readers.builder import get_reader_by_object
+from digitalhub.readers.api import get_reader_by_object
+
+if typing.TYPE_CHECKING:
+    from digitalhub.stores.local.store import LocalStore
 
 
 class LocalDatastore(Datastore):
@@ -12,6 +16,10 @@ 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

@@ -1,15 +1,23 @@
 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
+
 
 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

@@ -1,10 +1,14 @@
 from __future__ import annotations
 
+import typing
 from io import BytesIO
 from typing import Any
 
 from digitalhub.datastores._base.datastore import Datastore
-from digitalhub.readers.builder import get_reader_by_object
+from digitalhub.readers.api import get_reader_by_object
+
+if typing.TYPE_CHECKING:
+    from digitalhub.stores.s3.store import S3Store
 
 
 class S3Datastore(Datastore):
@@ -12,6 +16,10 @@ 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

@@ -1,9 +1,13 @@
 from __future__ import annotations
 
+import typing
 from typing import Any
 
 from digitalhub.datastores._base.datastore import Datastore
-from digitalhub.readers.builder import get_reader_by_object
+from digitalhub.readers.api import get_reader_by_object
+
+if typing.TYPE_CHECKING:
+    from digitalhub.stores.sql.store import SqlStore
 
 
 class SqlDatastore(Datastore):
@@ -11,6 +15,10 @@ 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().