digitalhub 0.13.0b2__py3-none-any.whl → 0.13.0b3__py3-none-any.whl

digitalhub/__init__.py

@@ -104,7 +104,7 @@ except ImportError:
 # Register entities into registry
 from digitalhub.factory.utils import register_entities, register_runtimes_entities
 from digitalhub.stores.client.dhcore.utils import refresh_token, set_dhcore_env
-from digitalhub.stores.credentials.api import get_current_env, set_current_env
+from digitalhub.stores.credentials.api import get_current_profile, set_current_profile
 
 register_entities()
 register_runtimes_entities()

digitalhub/context/api.py

@@ -17,15 +17,15 @@ def build_context(project: Project, overwrite: bool = False) -> Context:
     """
     Build a new context for a project.
 
-    Creates or updates a context instance for the given project in the global
-    context registry.
+    Creates or updates a context instance for the given project
+    in the global context registry.
 
     Parameters
     ----------
     project : Project
         The project object used to build the context.
     overwrite : bool, optional
-        If True, overwrites existing context if it exists, by default False.
+        If True, overwrites existing context if it exists. Default is False.
 
     Returns
     -------
@@ -37,7 +37,7 @@ def build_context(project: Project, overwrite: bool = False) -> Context:
 
 def get_context(project: str) -> Context:
     """
-    Wrapper for ContextBuilder.get().
+    Get the context for a given project name.
 
     Parameters
     ----------
@@ -54,7 +54,7 @@ def get_context(project: str) -> Context:
 
 def delete_context(project: str) -> None:
     """
-    Wrapper for ContextBuilder.remove().
+    Delete the context for a given project name.
 
     Parameters
     ----------

digitalhub/context/builder.py

@@ -39,8 +39,7 @@ class ContextBuilder:
         project : Project
             The project instance to create a context for.
         overwrite : bool, optional
-            If True, overwrites existing context if project name already exists,
-            by default False.
+            If True, overwrites existing context if project name already exists. Default is False.
 
         Returns
         -------
@@ -87,12 +86,11 @@ class ContextBuilder:
         Returns
         -------
         None
-            This method doesn't return anything.
+            This method does not return anything.
 
         Notes
         -----
-        If the project doesn't exist in the registry, this method
-        silently does nothing.
+        If the project does not exist in the registry, this method silently does nothing.
         """
         self._instances.pop(project, None)
 

digitalhub/context/context.py

@@ -56,6 +56,10 @@ class Context:
         ----------
         run_ctx : str
             The run key to set.
+
+        Returns
+        -------
+        None
         """
         self.is_running = True
         self._run_ctx = run_ctx
@@ -63,6 +67,10 @@ class Context:
     def unset_run(self) -> None:
         """
         Clear the current run key and reset running state.
+
+        Returns
+        -------
+        None
         """
         self.is_running = False
         self._run_ctx = None
@@ -73,7 +81,7 @@ class Context:
 
         Returns
         -------
-        str | None
+        str or None
             The current run key if set, None otherwise.
         """
         return self._run_ctx

digitalhub/entities/_base/material/entity.py

@@ -82,7 +82,7 @@ class MaterialEntity(VersionedEntity):
         list[str]
             List of file paths.
         """
-        store = get_store(self.project, self.spec.path)
+        store = get_store(self.spec.path)
         dst = store._build_temp()
         return store.download(self.spec.path, dst=dst)
 
@@ -121,7 +121,7 @@ class MaterialEntity(VersionedEntity):
         >>> print(path)
         dataitem/data.csv
         """
-        store = get_store(self.project, self.spec.path)
+        store = get_store(self.spec.path)
 
         if destination is None:
             dst = self._context().root / self.ENTITY_TYPE
@@ -158,7 +158,7 @@ class MaterialEntity(VersionedEntity):
         >>> entity.upload('./data')
         """
         # Get store and upload object
-        store = get_store(self.project, self.spec.path)
+        store = get_store(self.spec.path)
         paths = store.upload(source, self.spec.path)
 
         # Update files info

digitalhub/entities/dataitem/crud.py

@@ -131,8 +131,16 @@ def log_dataitem(
         cleanup = True
 
     source = eval_source(source, data, kind, name, project)
-    data = eval_data(project, kind, source, data, file_format, engine)
-    kwargs = process_kwargs(project, name, kind, source=source, data=data, path=path, **kwargs)
+    data = eval_data(kind, source, data, file_format, engine)
+    kwargs = process_kwargs(
+        project,
+        name,
+        kind,
+        source=source,
+        data=data,
+        path=path,
+        **kwargs,
+    )
     obj = context_processor.log_material_entity(
         source=source,
         project=project,

digitalhub/entities/dataitem/table/entity.py

@@ -93,14 +93,14 @@ class DataitemTable(Dataitem):
             DataFrame.
         """
         if self._query is not None:
-            df = get_store(self.project, self.spec.path).query(
+            df = get_store(self.spec.path).query(
                 self._query,
                 self.spec.path,
                 engine,
             )
             self._query = None
             return df
-        return get_store(self.project, self.spec.path).read_df(
+        return get_store(self.spec.path).read_df(
             self.spec.path,
             file_format,
             engine,
@@ -132,7 +132,7 @@ class DataitemTable(Dataitem):
         str
             Path to the written dataframe.
         """
-        return get_store(self.project, self.spec.path).write_df(
+        return get_store(self.spec.path).write_df(
             df,
             self.spec.path,
             extension=extension,

digitalhub/entities/dataitem/utils.py

@@ -62,7 +62,6 @@ def eval_source(
 
 
 def eval_data(
-    project: str,
     kind: str,
     source: SourcesOrListOfSources,
     data: Any | None = None,
@@ -91,7 +90,7 @@ def eval_data(
     """
     if kind == EntityKinds.DATAITEM_TABLE.value:
         if data is None:
-            return get_store(project, source).read_df(
+            return get_store(source).read_df(
                 source,
                 file_format=file_format,
                 engine=engine,

digitalhub/entities/task/_base/models.py

@@ -17,6 +17,7 @@ class VolumeType(Enum):
 
     PERSISTENT_VOLUME_CLAIM = "persistent_volume_claim"
     EMPTY_DIR = "empty_dir"
+    EPHEMERAL = "ephemeral"
 
 
 class SpecEmptyDir(BaseModel):
@@ -24,7 +25,7 @@ class SpecEmptyDir(BaseModel):
     Spec empty dir model.
     """
 
-    size_limit: str
+    size_limit: Optional[str] = None
 
     medium: Optional[str] = None
 
@@ -34,7 +35,15 @@ class SpecPVC(BaseModel):
     Spec PVC model.
     """
 
-    size: str
+    size: Optional[str] = None
+
+
+class SpecEphemeral(BaseModel):
+    """
+    Ephemeral volume model.
+    """
+
+    size: Optional[str] = None
 
 
 class Volume(BaseModel):
@@ -53,7 +62,7 @@ class Volume(BaseModel):
     mount_path: str
     """Volume mount path inside the container."""
 
-    spec: Optional[Union[SpecEmptyDir, SpecPVC]] = None
+    spec: Optional[Union[SpecEmptyDir, SpecPVC, SpecEphemeral]] = None
     """Volume spec."""
 
 

digitalhub/factory/factory.py

@@ -55,9 +55,13 @@ class Factory:
         ----------
         name : str
             The unique identifier for the builder.
-        builder : EntityBuilder | RuntimeEntityBuilder
+        builder : EntityBuilder or RuntimeEntityBuilder
             The builder instance to register.
 
+        Returns
+        -------
+        None
+
         Raises
         ------
         BuilderError
@@ -78,6 +82,10 @@ class Factory:
         builder : RuntimeBuilder
             The builder instance to register.
 
+        Returns
+        -------
+        None
+
         Raises
         ------
         BuilderError
@@ -137,6 +145,8 @@ class Factory:
         ----------
         kind_to_build_from : str
             Entity type.
+        **kwargs
+            Additional spec parameters.
 
         Returns
         -------
@@ -154,6 +164,8 @@ class Factory:
         ----------
         kind_to_build_from : str
             Entity type.
+        **kwargs
+            Additional metadata parameters.
 
         Returns
         -------
@@ -171,6 +183,8 @@ class Factory:
         ----------
         kind_to_build_from : str
             Entity type.
+        **kwargs
+            Additional status parameters.
 
         Returns
         -------
@@ -265,7 +279,7 @@ class Factory:
 
         Returns
         -------
-        list[str]
+        list of str
             Task kinds.
         """
         self._raise_if_entity_builder_not_found(kind)
@@ -299,7 +313,7 @@ class Factory:
 
         Returns
         -------
-        list[str]
+        list of str
             All kinds.
         """
         return self._entity_builders[kind].get_all_kinds()
@@ -330,6 +344,10 @@ class Factory:
         kind : str
             The entity kind to verify.
 
+        Returns
+        -------
+        None
+
         Raises
         ------
         BuilderError
@@ -347,6 +365,10 @@ class Factory:
         kind : str
             The runtime kind to verify.
 
+        Returns
+        -------
+        None
+
         Raises
         ------
         BuilderError

digitalhub/factory/utils.py

@@ -50,7 +50,7 @@ def list_runtimes() -> list[str]:
 
     Returns
     -------
-    list[str]
+    list of str
         List of runtime package names.
 
     Raises
@@ -75,6 +75,10 @@ def register_runtimes_entities() -> None:
 
     Imports each runtime package and registers its entity and runtime
     builders with the global factory instance.
+
+    Returns
+    -------
+    None
     """
     for package in list_runtimes():
         module = import_module(package)
@@ -93,8 +97,12 @@ def register_entities() -> None:
     """
     Register core entity builders into the factory.
 
-    Imports the core entities module and registers all entity builders
-    with the global factory instance.
+    Imports the core entities module and registers all entity
+    builders with the global factory instance.
+
+    Returns
+    -------
+    None
 
     Raises
     ------

digitalhub/runtimes/_base.py

@@ -89,7 +89,7 @@ class Runtime:
             Function to execute.
         *args
             Function arguments.
-        **kwargs : dict
+        **kwargs
             Function keyword arguments.
 
         Returns

digitalhub/runtimes/builder.py

@@ -34,12 +34,29 @@ class RuntimeBuilder:
     RUNTIME_CLASS: Runtime = None
 
     def __init__(self) -> None:
+        """
+        Initialize a RuntimeBuilder instance.
+
+        Raises
+        ------
+        BuilderError
+            If RUNTIME_CLASS is not set in the implementing class.
+        """
         if self.RUNTIME_CLASS is None:
             raise BuilderError("RUNTIME_CLASS must be set")
 
     def build(self, project: str, *args, **kwargs) -> Runtime:
         """
-        Build runtime object.
+        Build a runtime object.
+
+        Parameters
+        ----------
+        project : str
+            The project identifier for the runtime instance.
+        *args
+            Additional positional arguments to pass to the Runtime constructor.
+        **kwargs
+            Additional keyword arguments to pass to the Runtime constructor.
 
         Returns
         -------

digitalhub/stores/client/__init__.py

@@ -1,3 +1,15 @@
 # SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
 #
 # SPDX-License-Identifier: Apache-2.0
+
+"""
+Client module for DigitalHub SDK.
+
+This module provides client implementations for interacting with different
+backends:
+- Local client for in-memory operations
+- DHCore client for remote backend communication
+
+The main entry point is through the get_client function which returns
+the appropriate client instance based on the configuration.
+"""

digitalhub/stores/client/_base/api_builder.py

@@ -17,4 +17,18 @@ class ClientApiBuilder:
     def build_api(self, category: str, operation: str, **kwargs) -> str:
         """
         Build the API for the client.
+
+        Parameters
+        ----------
+        category : str
+            The API category.
+        operation : str
+            The API operation.
+        **kwargs : dict
+            Additional keyword arguments.
+
+        Returns
+        -------
+        str
+            The formatted API endpoint.
         """

digitalhub/stores/client/_base/client.py

@@ -36,42 +36,130 @@ class Client:
     def create_object(self, api: str, obj: Any, **kwargs) -> dict:
         """
         Create object method.
+
+        Parameters
+        ----------
+        api : str
+            The API endpoint to create the object.
+        obj : Any
+            The object to create.
+        **kwargs : dict
+            Additional keyword arguments.
+
+        Returns
+        -------
+        dict
+            The created object.
         """
 
     @abstractmethod
     def read_object(self, api: str, **kwargs) -> dict:
         """
         Read object method.
+
+        Parameters
+        ----------
+        api : str
+            The API endpoint to read the object.
+        **kwargs : dict
+            Additional keyword arguments.
+
+        Returns
+        -------
+        dict
+            The retrieved object.
         """
 
     @abstractmethod
     def update_object(self, api: str, obj: Any, **kwargs) -> dict:
         """
         Update object method.
+
+        Parameters
+        ----------
+        api : str
+            The API endpoint to update the object.
+        obj : Any
+            The object to update.
+        **kwargs : dict
+            Additional keyword arguments.
+
+        Returns
+        -------
+        dict
+            The updated object.
         """
 
     @abstractmethod
     def delete_object(self, api: str, **kwargs) -> dict:
         """
         Delete object method.
+
+        Parameters
+        ----------
+        api : str
+            The API endpoint to delete the object.
+        **kwargs : dict
+            Additional keyword arguments.
+
+        Returns
+        -------
+        dict
+            The deletion result.
         """
 
     @abstractmethod
     def list_objects(self, api: str, **kwargs) -> dict:
         """
         List objects method.
+
+        Parameters
+        ----------
+        api : str
+            The API endpoint to list objects.
+        **kwargs : dict
+            Additional keyword arguments.
+
+        Returns
+        -------
+        dict
+            The list of objects.
         """
 
     @abstractmethod
     def list_first_object(self, api: str, **kwargs) -> dict:
         """
         Read first object method.
+
+        Parameters
+        ----------
+        api : str
+            The API endpoint to read the first object.
+        **kwargs : dict
+            Additional keyword arguments.
+
+        Returns
+        -------
+        dict
+            The first object in the list.
         """
 
     @abstractmethod
     def search_objects(self, api: str, **kwargs) -> dict:
         """
         Search objects method.
+
+        Parameters
+        ----------
+        api : str
+            The API endpoint to search objects.
+        **kwargs : dict
+            Additional keyword arguments containing search parameters.
+
+        Returns
+        -------
+        dict
+            The search results.
         """
 
     ##############################
@@ -147,4 +235,9 @@ class Client:
     def is_local() -> bool:
         """
         Flag to check if client is local.
+
+        Returns
+        -------
+        bool
+            True if the client operates locally, False otherwise.
         """

digitalhub/stores/client/_base/key_builder.py

@@ -40,6 +40,16 @@ class ClientKeyBuilder:
     def base_entity_key(self, entity_id: str) -> str:
         """
         Build for base entity key.
+
+        Parameters
+        ----------
+        entity_id : str
+            The entity identifier.
+
+        Returns
+        -------
+        str
+            The formatted base entity key.
         """
 
     @abstractmethod
@@ -53,4 +63,22 @@ class ClientKeyBuilder:
     ) -> str:
         """
         Build for context entity key.
+
+        Parameters
+        ----------
+        project : str
+            The project name.
+        entity_type : str
+            The entity type.
+        entity_kind : str
+            The entity kind.
+        entity_name : str
+            The entity name.
+        entity_id : str, optional
+            The entity identifier. If None, key will not include version.
+
+        Returns
+        -------
+        str
+            The formatted context entity key.
         """

digitalhub/stores/client/_base/params_builder.py

@@ -17,4 +17,18 @@ class ClientParametersBuilder:
     def build_parameters(self, category: str, operation: str, **kwargs) -> dict:
         """
         Build the parameters for the client call.
+
+        Parameters
+        ----------
+        category : str
+            The API category.
+        operation : str
+            The API operation.
+        **kwargs : dict
+            Additional keyword arguments to build parameters from.
+
+        Returns
+        -------
+        dict
+            The formatted parameters for the client call.
         """

digitalhub/stores/client/api.py

@@ -18,14 +18,19 @@ def get_client(local: bool = False, config: dict | None = None) -> Client:
 
     Parameters
     ----------
-    local : bool
-        Whether to create a local client or not.
-    config : dict
-        DHCore environment configuration.
+    local : bool, default False
+        Whether to create a local client or not. If True, creates a
+        ClientLocal instance that operates in-memory. If False, creates
+        a ClientDHCore instance that communicates with a remote backend.
+    config : dict, optional
+        DHCore environment configuration. Only used when local=False.
+        If None, configuration will be loaded from environment variables
+        and configuration files.
 
     Returns
     -------
     Client
-        The client instance.
+        The client instance. Either ClientLocal or ClientDHCore depending
+        on the local parameter.
     """
     return client_builder.build(local, config)

digitalhub/stores/client/builder.py

@@ -33,8 +33,10 @@ class ClientBuilder:
 
         Parameters
         ----------
-        local : bool
+        local : bool, default False
             Whether to create a local client or not.
+        config : dict, optional
+            DHCore environment configuration.
 
         Returns
         -------