zenml-nightly 0.75.0.dev20250313__py3-none-any.whl → 0.75.0.dev20250314__py3-none-any.whl

zenml/cli/workspace.py

@@ -1,160 +0,0 @@
-#  Copyright (c) ZenML GmbH 2022. All Rights Reserved.
-#
-#  Licensed under the Apache License, Version 2.0 (the "License");
-#  you may not use this file except in compliance with the License.
-#  You may obtain a copy of the License at:
-#
-#       https://www.apache.org/licenses/LICENSE-2.0
-#
-#  Unless required by applicable law or agreed to in writing, software
-#  distributed under the License is distributed on an "AS IS" BASIS,
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
-#  or implied. See the License for the specific language governing
-#  permissions and limitations under the License.
-"""Functionality to administer workspaces of the ZenML CLI and server."""
-
-from typing import Any, Optional
-
-import click
-
-from zenml.cli import utils as cli_utils
-from zenml.cli.cli import TagGroup, cli
-from zenml.cli.utils import (
-    check_zenml_pro_workspace_availability,
-    is_sorted_or_filtered,
-    list_options,
-)
-from zenml.client import Client
-from zenml.console import console
-from zenml.enums import CliCategories
-from zenml.models import WorkspaceFilter
-
-
-@cli.group(cls=TagGroup, tag=CliCategories.MANAGEMENT_TOOLS)
-def workspace() -> None:
-    """Commands for workspace management."""
-
-
-@workspace.command("list")
-@list_options(WorkspaceFilter)
-@click.pass_context
-def list_workspaces(ctx: click.Context, **kwargs: Any) -> None:
-    """List all workspaces.
-
-    Args:
-        ctx: The click context object
-        **kwargs: Keyword arguments to filter the list of workspaces.
-    """
-    check_zenml_pro_workspace_availability()
-    client = Client()
-    with console.status("Listing workspaces...\n"):
-        workspaces = client.list_workspaces(**kwargs)
-        if workspaces:
-            cli_utils.print_pydantic_models(
-                workspaces,
-                exclude_columns=["id", "created", "updated"],
-                active_models=[Client().active_workspace],
-                show_active=not is_sorted_or_filtered(ctx),
-            )
-        else:
-            cli_utils.declare("No workspaces found for the given filter.")
-
-
-@workspace.command("register")
-@click.option(
-    "--set",
-    "set_workspace",
-    is_flag=True,
-    help="Immediately set this workspace as active.",
-    type=click.BOOL,
-)
-@click.argument("workspace_name", type=str, required=True)
-def register_workspace(
-    workspace_name: str, set_workspace: bool = False
-) -> None:
-    """Register a new workspace.
-
-    Args:
-        workspace_name: The name of the workspace to register.
-        set_workspace: Whether to set the workspace as active.
-    """
-    check_zenml_pro_workspace_availability()
-    client = Client()
-    with console.status("Creating workspace...\n"):
-        try:
-            client.create_workspace(workspace_name, description="")
-            cli_utils.declare("Workspace created successfully.")
-        except Exception as e:
-            cli_utils.error(str(e))
-
-    if set_workspace:
-        client.set_active_workspace(workspace_name)
-        cli_utils.declare(
-            f"The active workspace has been set to {workspace_name}"
-        )
-
-
-@workspace.command("set")
-@click.argument("workspace_name_or_id", type=str, required=True)
-def set_workspace(workspace_name_or_id: str) -> None:
-    """Set the active workspace.
-
-    Args:
-        workspace_name_or_id: The name or ID of the workspace to set as active.
-    """
-    check_zenml_pro_workspace_availability()
-    client = Client()
-    with console.status("Setting workspace...\n"):
-        try:
-            client.set_active_workspace(workspace_name_or_id)
-            cli_utils.declare(
-                f"The active workspace has been set to {workspace_name_or_id}"
-            )
-        except Exception as e:
-            cli_utils.error(str(e))
-
-
-@workspace.command("describe")
-@click.argument("workspace_name_or_id", type=str, required=False)
-def describe_workspace(workspace_name_or_id: Optional[str] = None) -> None:
-    """Get the workspace.
-
-    Args:
-        workspace_name_or_id: The name or ID of the workspace to set as active.
-    """
-    check_zenml_pro_workspace_availability()
-    client = Client()
-    if not workspace_name_or_id:
-        active_workspace = client.active_workspace
-        cli_utils.print_pydantic_models(
-            [active_workspace], exclude_columns=["created", "updated"]
-        )
-    else:
-        try:
-            workspace_ = client.get_workspace(workspace_name_or_id)
-        except KeyError as err:
-            cli_utils.error(str(err))
-        else:
-            cli_utils.print_pydantic_models(
-                [workspace_], exclude_columns=["created", "updated"]
-            )
-
-
-@workspace.command("delete")
-@click.argument("workspace_name_or_id", type=str, required=True)
-def delete_workspace(workspace_name_or_id: str) -> None:
-    """Delete a workspace.
-
-    Args:
-        workspace_name_or_id: The name or ID of the workspace to delete.
-    """
-    check_zenml_pro_workspace_availability()
-    client = Client()
-    with console.status("Deleting workspace...\n"):
-        try:
-            client.delete_workspace(workspace_name_or_id)
-            cli_utils.declare(
-                f"Workspace '{workspace_name_or_id}' deleted successfully."
-            )
-        except Exception as e:
-            cli_utils.error(str(e))

zenml/models/v2/core/workspace.py

@@ -1,131 +0,0 @@
-#  Copyright (c) ZenML GmbH 2023. All Rights Reserved.
-#
-#  Licensed under the Apache License, Version 2.0 (the "License");
-#  you may not use this file except in compliance with the License.
-#  You may obtain a copy of the License at:
-#
-#       https://www.apache.org/licenses/LICENSE-2.0
-#
-#  Unless required by applicable law or agreed to in writing, software
-#  distributed under the License is distributed on an "AS IS" BASIS,
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
-#  or implied. See the License for the specific language governing
-#  permissions and limitations under the License.
-"""Models representing workspaces."""
-
-from typing import Optional
-
-from pydantic import Field
-
-from zenml.constants import STR_FIELD_MAX_LENGTH
-from zenml.models.v2.base.base import (
-    BaseDatedResponseBody,
-    BaseIdentifiedResponse,
-    BaseRequest,
-    BaseResponseMetadata,
-    BaseResponseResources,
-    BaseUpdate,
-)
-from zenml.models.v2.base.filter import BaseFilter
-
-# ------------------ Request Model ------------------
-
-
-class WorkspaceRequest(BaseRequest):
-    """Request model for workspaces."""
-
-    name: str = Field(
-        title="The unique name of the workspace.",
-        max_length=STR_FIELD_MAX_LENGTH,
-    )
-    description: str = Field(
-        default="",
-        title="The description of the workspace.",
-        max_length=STR_FIELD_MAX_LENGTH,
-    )
-
-
-# ------------------ Update Model ------------------
-
-
-class WorkspaceUpdate(BaseUpdate):
-    """Update model for workspaces."""
-
-    name: Optional[str] = Field(
-        title="The unique name of the workspace.",
-        max_length=STR_FIELD_MAX_LENGTH,
-        default=None,
-    )
-    description: Optional[str] = Field(
-        title="The description of the workspace.",
-        max_length=STR_FIELD_MAX_LENGTH,
-        default=None,
-    )
-
-
-# ------------------ Response Model ------------------
-
-
-class WorkspaceResponseBody(BaseDatedResponseBody):
-    """Response body for workspaces."""
-
-
-class WorkspaceResponseMetadata(BaseResponseMetadata):
-    """Response metadata for workspaces."""
-
-    description: str = Field(
-        default="",
-        title="The description of the workspace.",
-        max_length=STR_FIELD_MAX_LENGTH,
-    )
-
-
-class WorkspaceResponseResources(BaseResponseResources):
-    """Class for all resource models associated with the workspace entity."""
-
-
-class WorkspaceResponse(
-    BaseIdentifiedResponse[
-        WorkspaceResponseBody,
-        WorkspaceResponseMetadata,
-        WorkspaceResponseResources,
-    ]
-):
-    """Response model for workspaces."""
-
-    name: str = Field(
-        title="The unique name of the workspace.",
-        max_length=STR_FIELD_MAX_LENGTH,
-    )
-
-    def get_hydrated_version(self) -> "WorkspaceResponse":
-        """Get the hydrated version of this workspace.
-
-        Returns:
-            an instance of the same entity with the metadata field attached.
-        """
-        from zenml.client import Client
-
-        return Client().zen_store.get_workspace(self.id)
-
-    # Body and metadata properties
-    @property
-    def description(self) -> str:
-        """The `description` property.
-
-        Returns:
-            the value of the property.
-        """
-        return self.get_metadata().description
-
-
-# ------------------ Filter Model ------------------
-
-
-class WorkspaceFilter(BaseFilter):
-    """Model to enable advanced filtering of all Workspaces."""
-
-    name: Optional[str] = Field(
-        default=None,
-        description="Name of the workspace",
-    )