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

digitalhub/entities/project/spec.py

@@ -0,0 +1,50 @@
+from __future__ import annotations
+
+from digitalhub.entities._base.spec.base import Spec, SpecParams
+
+
+class ProjectSpec(Spec):
+    """
+    Project specification.
+    """
+
+    def __init__(
+        self,
+        context: str | None = None,
+        functions: list | None = None,
+        artifacts: list | None = None,
+        workflows: list | None = None,
+        dataitems: list | None = None,
+        models: list | None = None,
+        **kwargs,
+    ) -> None:
+        self.context = context if context is not None else "./"
+        self.functions = functions if functions is not None else []
+        self.artifacts = artifacts if artifacts is not None else []
+        self.workflows = workflows if workflows is not None else []
+        self.dataitems = dataitems if dataitems is not None else []
+        self.models = models if models is not None else []
+
+
+class ProjectParams(SpecParams):
+    """
+    Parameters model for project.
+    """
+
+    context: str = None
+    """The project's context."""
+
+    functions: list = None
+    """List of project's functions."""
+
+    artifacts: list = None
+    """List of project's artifacts."""
+
+    workflows: list = None
+    """List of project's workflows."""
+
+    dataitems: list = None
+    """List of project's dataitems."""
+
+    models: list = None
+    """List of project's models."""

digitalhub/entities/project/status.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from digitalhub.entities._base.status.base import Status
+
+
+class ProjectStatus(Status):
+    """
+    Status class for project entities.
+    """

digitalhub/entities/registries.py

@@ -0,0 +1,48 @@
+from __future__ import annotations
+
+from digitalhub.entities.entity_types import EntityTypes
+from digitalhub.registry.registry import registry
+from digitalhub.registry.utils import create_info
+
+# Root module
+root = "digitalhub.entities"
+
+# Projects
+entity_type = EntityTypes.PROJECT.value
+prefix = entity_type.capitalize()
+project_info = create_info(root, entity_type, prefix)
+registry.register("project", project_info)
+
+
+# Secrets
+entity_type = EntityTypes.SECRET.value
+prefix = entity_type.capitalize()
+secret_info = create_info(root, entity_type, prefix)
+registry.register("secret", secret_info)
+
+
+# Artifacts
+entity_type = EntityTypes.ARTIFACT.value
+for i in ["artifact"]:
+    prefix = entity_type.capitalize()
+    suffix = i.capitalize()
+    artifact_info = create_info(root, entity_type, prefix, suffix)
+    registry.register(i, artifact_info)
+
+
+# Dataitems
+entity_type = EntityTypes.DATAITEM.value
+for i in ["dataitem", "table"]:
+    prefix = entity_type.capitalize()
+    suffix = i.capitalize()
+    dataitem_info = create_info(root, entity_type, prefix, suffix)
+    registry.register(i, dataitem_info)
+
+
+# Models
+entity_type = EntityTypes.MODEL.value
+for i in ["model", "mlflow", "sklearn", "huggingface"]:
+    prefix = entity_type.capitalize()
+    suffix = i.capitalize()
+    model_info = create_info(root, entity_type, prefix, suffix)
+    registry.register(i, model_info)

digitalhub/entities/run/builder.py

@@ -0,0 +1,77 @@
+from __future__ import annotations
+
+from digitalhub.entities._builders.metadata import build_metadata
+from digitalhub.entities._builders.spec import build_spec
+from digitalhub.entities._builders.status import build_status
+from digitalhub.entities._builders.uuid import build_uuid
+from digitalhub.entities.run.entity import Run
+
+
+def run_from_parameters(
+    project: str,
+    kind: str,
+    uuid: str | None = None,
+    labels: list[str] | None = None,
+    task: str | None = None,
+    local_execution: bool = False,
+    **kwargs,
+) -> Run:
+    """
+    Create run.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+    kind : str
+        Kind the object.
+    uuid : str
+        ID of the object (UUID4, e.g. 40f25c4b-d26b-4221-b048-9527aff291e2).
+    labels : list[str]
+        List of labels.
+    task : str
+        Name of the task associated with the run.
+    local_execution : bool
+        Flag to determine if object has local execution.
+    **kwargs : dict
+        Spec keyword arguments.
+
+    Returns
+    -------
+    Run
+        Object instance.
+    """
+    uuid = build_uuid(uuid)
+    metadata = build_metadata(
+        kind=kind,
+        project=project,
+        name=uuid,
+        labels=labels,
+    )
+    spec = build_spec(kind, task=task, local_execution=local_execution, **kwargs)
+    status = build_status(kind)
+    return Run(
+        project=project,
+        uuid=uuid,
+        kind=kind,
+        metadata=metadata,
+        spec=spec,
+        status=status,
+    )
+
+
+def run_from_dict(obj: dict) -> Run:
+    """
+    Create a new object from dictionary.
+
+    Parameters
+    ----------
+    obj : dict
+        Dictionary to create object from.
+
+    Returns
+    -------
+    Run
+        Object instance.
+    """
+    return Run.from_dict(obj)

digitalhub/entities/run/crud.py

@@ -0,0 +1,232 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.context.builder import check_context
+from digitalhub.entities._base.crud import delete_entity_api_ctx, list_entity_api_ctx, read_entity_api_ctx
+from digitalhub.entities.entity_types import EntityTypes
+from digitalhub.entities.run.builder import run_from_dict, run_from_parameters
+from digitalhub.utils.exceptions import EntityAlreadyExistsError, EntityError
+from digitalhub.utils.io_utils import read_yaml
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities.run.entity import Run
+
+
+ENTITY_TYPE = EntityTypes.RUN.value
+
+
+def new_run(
+    project: str,
+    kind: str,
+    uuid: str | None = None,
+    labels: list[str] | None = None,
+    task: str | None = None,
+    local_execution: bool = False,
+    **kwargs,
+) -> Run:
+    """
+    Create a new object.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+    kind : str
+        Kind the object.
+    uuid : str
+        ID of the object (UUID4, e.g. 40f25c4b-d26b-4221-b048-9527aff291e2).
+    labels : list[str]
+        List of labels.
+    task : str
+        Name of the task associated with the run.
+    local_execution : bool
+        Flag to determine if object has local execution.
+    **kwargs : dict
+        Spec keyword arguments.
+
+    Returns
+    -------
+    Run
+        Object instance.
+
+    Examples
+    --------
+    >>> obj = new_function(project="my-project",
+    >>>                    name="my-function",
+    >>>                    kind="python+run",
+    >>>                    task="task-string"
+    """
+    check_context(project)
+    obj = run_from_parameters(
+        project=project,
+        kind=kind,
+        uuid=uuid,
+        labels=labels,
+        task=task,
+        local_execution=local_execution,
+        **kwargs,
+    )
+    obj.save()
+    return obj
+
+
+def get_run(
+    identifier: str,
+    project: str | None = None,
+    **kwargs,
+) -> Run:
+    """
+    Get object from backend.
+
+    Parameters
+    ----------
+    identifier : str
+        Entity key (store://...) or entity ID.
+    project : str
+        Project name.
+    **kwargs : dict
+        Parameters to pass to the API call.
+
+    Returns
+    -------
+    Run
+        Object instance.
+
+    Examples
+    --------
+    Using entity key:
+    >>> obj = get_run("store://my-run-key")
+
+    Using entity ID:
+    >>> obj = get_run("my-run-id"
+    >>>               project="my-project")
+    """
+    if not identifier.startswith("store://") and project is None:
+        raise EntityError("Specify entity key or entity ID combined with project")
+    obj = read_entity_api_ctx(
+        identifier,
+        ENTITY_TYPE,
+        project=project,
+        entity_id=identifier,
+        **kwargs,
+    )
+    return run_from_dict(obj)
+
+
+def list_runs(project: str, **kwargs) -> list[Run]:
+    """
+    List all latest version objects from backend.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+    **kwargs : dict
+        Parameters to pass to the API call.
+
+    Returns
+    -------
+    list[Run]
+        List of object instances.
+
+    Examples
+    --------
+    >>> objs = list_runs(project="my-project")
+    """
+    # TODO more examples: search by function, latest for task and function
+    objs = list_entity_api_ctx(
+        project=project,
+        entity_type=ENTITY_TYPE,
+        **kwargs,
+    )
+    return [run_from_dict(obj) for obj in objs]
+
+
+def import_run(file: str) -> Run:
+    """
+    Get object from file.
+
+    Parameters
+    ----------
+    file : str
+        Path to YAML file.
+
+    Returns
+    -------
+    Run
+        Object instance.
+
+    Example
+    -------
+    >>> obj = import_run("my-run.yaml")
+    """
+    dict_obj: dict = read_yaml(file)
+    obj = run_from_dict(dict_obj)
+    try:
+        obj.save()
+    except EntityAlreadyExistsError:
+        pass
+    finally:
+        return obj
+
+
+def update_run(entity: Run) -> Run:
+    """
+    Update object. Note that object spec are immutable.
+
+    Parameters
+    ----------
+    entity : Run
+        Object to update.
+
+    Returns
+    -------
+    Run
+        Entity updated.
+
+    Examples
+    --------
+    >>> obj = update_run(obj)
+    """
+    return entity.save(update=True)
+
+
+def delete_run(
+    identifier: str,
+    project: str | None = None,
+    **kwargs,
+) -> dict:
+    """
+    Delete object from backend.
+
+    Parameters
+    ----------
+    identifier : str
+        Entity key (store://...) or entity ID.
+    project : str
+        Project name.
+    **kwargs : dict
+        Parameters to pass to the API call.
+
+    Returns
+    -------
+    dict
+        Response from backend.
+
+    Examples
+    --------
+    >>> obj = delete_run("store://my-run-key")
+    >>> obj = delete_run("my-run-id", project="my-project")
+    """
+    if not identifier.startswith("store://") and project is None:
+        raise EntityError("Specify entity key or entity ID combined with project")
+    return delete_entity_api_ctx(
+        identifier=identifier,
+        entity_type=ENTITY_TYPE,
+        project=project,
+        entity_id=identifier,
+        **kwargs,
+    )
+
+    # TODO read logs