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

zenml/VERSION

@@ -1 +1 @@
-0.75.0.dev20250313
+0.75.0.dev20250315

zenml/analytics/context.py

@@ -118,7 +118,7 @@ class AnalyticsContext:
                     self.external_user_id = auth_context.user.external_user_id
 
                 self.external_server_id = server_config().external_server_id
-                self.workspace_id = None
+                self.project_id = None
             else:
                 from zenml.client import Client
 
@@ -129,7 +129,7 @@ class AnalyticsContext:
                     active_user.is_service_account
                 )
                 self.external_user_id = active_user.external_user_id
-                self.workspace_id = Client().active_workspace.id
+                self.project_id = Client().active_project.id
 
             # Fetch the `client_id`
             if self.in_server:
@@ -308,8 +308,8 @@ class AnalyticsContext:
         if self.server_metadata:
             properties.update(self.server_metadata)
 
-        if self.workspace_id:
-            properties.setdefault("workspace_id", str(self.workspace_id))
+        if self.project_id:
+            properties.setdefault("project_id", str(self.project_id))
 
         for k, v in properties.items():
             if isinstance(v, UUID):

zenml/analytics/enums.py

@@ -65,8 +65,8 @@ class AnalyticsEvent(str, Enum):
     # Examples
     RUN_ZENML_GO = "ZenML go"
 
-    # Workspaces
-    CREATED_WORKSPACE = "Workspace created"
+    # Projects
+    CREATED_PROJECT = "Project created"
 
     # Flavor
     CREATED_FLAVOR = "Flavor created"

zenml/artifacts/utils.py

@@ -182,7 +182,7 @@ def _store_artifact_data_and_prepare_request(
         uri=materializer.uri,
         materializer=source_utils.resolve(materializer.__class__),
         data_type=source_utils.resolve(data_type),
-        workspace=Client().active_workspace.id,
+        project=Client().active_project.id,
         artifact_store_id=artifact_store.id,
         visualizations=visualizations,
         has_custom_name=has_custom_name,
@@ -349,7 +349,7 @@ def register_artifact(
         uri=folder_or_file_uri,
         materializer=source_utils.resolve(PreexistingDataMaterializer),
         data_type=source_utils.resolve(Path),
-        workspace=Client().active_workspace.id,
+        project=Client().active_project.id,
         artifact_store_id=artifact_store.id,
         has_custom_name=has_custom_name,
         metadata=validate_metadata(artifact_metadata)

zenml/cli/__init__.py

@@ -106,7 +106,7 @@ zenml go
 Cleaning up
 -----------
 
-If you wish to delete all data relating to your workspace from the
+If you wish to delete all data relating to your project from the
 directory, use the ``zenml clean`` command. This will:
 
 -  delete all pipelines, pipeline runs and associated metadata
@@ -367,8 +367,7 @@ information regarding a specific flavor, you can utilize the command:
 zenml orchestrator flavor describe FLAVOR_NAME
 ```
 
-If you wish to list the orchestrators that have already been registered
-within your ZenML workspace / repository, type:
+If you wish to list the orchestrators that have already been registered, type:
 
 ```bash
 zenml orchestrator list
@@ -1446,8 +1445,7 @@ simply pass along the `--set` flag.
 zenml stack register STACK_NAME ... --set
 ```
 
-To list the stacks that you have registered within your current ZenML
-workspace, type:
+To list the stacks that you have registered, type:
 
 ```bash
 zenml stack list
@@ -2070,9 +2068,10 @@ Finally, to delete a secret, use the `delete` command:
 zenml secret delete SECRET_NAME
 ```
 
-Secrets can be scoped to a workspace or a user. By default, secrets
-are scoped to the current workspace. To scope a secret to a user, use the
-`--scope user` argument in the `register` command.
+Secrets can be either private or public. Private secrets are only accessible
+to the current user. Public secrets are accessible to all other users. By
+default, secrets are public. To make a secret private, use the `--private` flag
+in the `create` or `update` commands.
 
 Auth management
 ---------------
@@ -2525,5 +2524,5 @@ from zenml.cli.service_connectors import *  # noqa
 from zenml.cli.stack import *  # noqa
 from zenml.cli.stack_components import *  # noqa
 from zenml.cli.user_management import *  # noqa
-from zenml.cli.workspace import *  # noqa
+from zenml.cli.project import *  # noqa
 from zenml.cli.tag import *  # noqa

zenml/cli/base.py

@@ -622,7 +622,7 @@ def info(
         "python_version": environment.python_version(),
         "environment": get_environment(),
         "system_info": environment.get_system_info(),
-        "active_workspace": client.active_workspace.name,
+        "active_project": client.active_project.name,
         "active_stack": client.active_stack_model.name,
         "active_user": client.active_user.name,
         "telemetry_status": "enabled" if gc.analytics_opt_in else "disabled",
@@ -674,7 +674,7 @@ def info(
     "--skip_default_registrations",
     is_flag=True,
     default=False,
-    help="Skip registering default workspace, user and stack.",
+    help="Skip registering default project, user and stack.",
     type=bool,
 )
 def migrate_database(skip_default_registrations: bool = False) -> None:

zenml/cli/code_repository.py

@@ -205,7 +205,7 @@ def list_code_repositories(**kwargs: Any) -> None:
 
         cli_utils.print_pydantic_models(
             repos,
-            exclude_columns=["created", "updated", "user", "workspace"],
+            exclude_columns=["created", "updated", "user", "project"],
         )
 
 

zenml/cli/login.py

@@ -246,7 +246,7 @@ def connect_to_pro_server(
     """
     from zenml.login.credentials_store import get_credentials_store
     from zenml.login.pro.client import ZenMLProClient
-    from zenml.login.pro.tenant.models import TenantStatus
+    from zenml.login.pro.workspace.models import WorkspaceStatus
 
     pro_api_url = pro_api_url or ZENML_PRO_API_URL
     pro_api_url = pro_api_url.rstrip("/")
@@ -295,7 +295,7 @@ def connect_to_pro_server(
         # We also need to remove all existing API tokens associated with the
         # target ZenML Pro API, otherwise they will continue to be used after
         # the re-login flow.
-        credentials_store.clear_all_pro_tokens(pro_api_url)
+        credentials_store.clear_all_pro_tokens()
         try:
             token = web_login(
                 pro_api_url=pro_api_url,
@@ -310,13 +310,14 @@ def connect_to_pro_server(
             "your session expires."
         )
 
-        tenant_id: Optional[str] = None
+        workspace_id: Optional[str] = None
         if token.device_metadata:
-            tenant_id = token.device_metadata.get("tenant_id")
+            # TODO: is this still correct?
+            workspace_id = token.device_metadata.get("tenant_id")
 
-        if tenant_id is None and pro_server is None:
+        if workspace_id is None and pro_server is None:
             # This is not really supposed to happen, because the implementation
-            # of the web login workflow should always return a tenant ID, but
+            # of the web login workflow should always return a workspace ID, but
             # we're handling it just in case.
             cli_utils.declare(
                 "A valid server was not selected during the login process. "
@@ -328,14 +329,14 @@ def connect_to_pro_server(
 
         # The server selected during the web login process overrides any
         # server argument passed to the command.
-        server_id = UUID(tenant_id)
+        server_id = UUID(workspace_id)
 
     client = ZenMLProClient(pro_api_url)
 
     if server_id:
-        server = client.tenant.get(server_id)
+        server = client.workspace.get(server_id)
     elif server_url:
-        servers = client.tenant.list(url=server_url, member_only=True)
+        servers = client.workspace.list(url=server_url, member_only=True)
         if not servers:
             raise AuthorizationException(
                 f"The '{server_url}' URL belongs to a ZenML Pro server, "
@@ -345,7 +346,9 @@ def connect_to_pro_server(
 
         server = servers[0]
     elif server_name:
-        servers = client.tenant.list(tenant_name=server_name, member_only=True)
+        servers = client.workspace.list(
+            workspace_name=server_name, member_only=True
+        )
         if not servers:
             raise AuthorizationException(
                 f"No ZenML Pro server with the name '{server_name}' exists "
@@ -361,15 +364,15 @@ def connect_to_pro_server(
 
     server_id = server.id
 
-    if server.status == TenantStatus.PENDING:
+    if server.status == WorkspaceStatus.PENDING:
         with console.status(
             f"Waiting for your `{server.name}` ZenML Pro server to be set up..."
         ):
             timeout = 180  # 3 minutes
             while True:
                 time.sleep(5)
-                server = client.tenant.get(server_id)
-                if server.status != TenantStatus.PENDING:
+                server = client.workspace.get(server_id)
+                if server.status != WorkspaceStatus.PENDING:
                     break
                 timeout -= 5
                 if timeout <= 0:
@@ -380,7 +383,7 @@ def connect_to_pro_server(
                         f"ZenML Pro dashboard at {server.dashboard_url}."
                     )
 
-    if server.status == TenantStatus.FAILED:
+    if server.status == WorkspaceStatus.FAILED:
         cli_utils.error(
             f"Your `{server.name}` ZenML Pro server is currently in a "
             "failed state. Please manage the server state by visiting the "
@@ -388,7 +391,7 @@ def connect_to_pro_server(
             "your server administrator."
         )
 
-    elif server.status == TenantStatus.DEACTIVATED:
+    elif server.status == WorkspaceStatus.DEACTIVATED:
         cli_utils.error(
             f"Your `{server.name}` ZenML Pro server is currently "
             "deactivated. Please manage the server state by visiting the "
@@ -396,7 +399,7 @@ def connect_to_pro_server(
             "your server administrator."
         )
 
-    elif server.status == TenantStatus.AVAILABLE:
+    elif server.status == WorkspaceStatus.AVAILABLE:
         if not server.url:
             cli_utils.error(
                 f"The ZenML Pro server '{server.name}' is not currently "
@@ -418,7 +421,7 @@ def connect_to_pro_server(
     connect_to_server(server.url, api_key=api_key, pro_server=True)
 
     # Update the stored server info with more accurate data taken from the
-    # ZenML Pro tenant object.
+    # ZenML Pro workspace object.
     credentials_store.update_server_info(server.url, server)
 
     cli_utils.declare(f"Connected to ZenML Pro server: {server.name}.")
@@ -836,7 +839,7 @@ def login(
                 pro_api_url=pro_api_url,
             )
 
-    elif current_non_local_server:
+    elif current_non_local_server and not refresh:
         # The server argument is not provided, so we default to
         # re-authenticating to the current non-local server that the client is
         # connected to.

zenml/cli/pipeline.py

@@ -382,7 +382,7 @@ def list_pipelines(**kwargs: Any) -> None:
 
         cli_utils.print_pydantic_models(
             pipelines,
-            exclude_columns=["id", "created", "updated", "user", "workspace"],
+            exclude_columns=["id", "created", "updated", "user", "project"],
         )
 
 
@@ -447,7 +447,7 @@ def list_schedules(**kwargs: Any) -> None:
 
     cli_utils.print_pydantic_models(
         schedules,
-        exclude_columns=["id", "created", "updated", "user", "workspace"],
+        exclude_columns=["id", "created", "updated", "user", "project"],
     )
 
 
@@ -600,7 +600,7 @@ def list_pipeline_builds(**kwargs: Any) -> None:
                 "created",
                 "updated",
                 "user",
-                "workspace",
+                "project",
                 "images",
                 "stack_checksum",
             ],

zenml/cli/project.py

@@ -0,0 +1,172 @@
+#  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 projects 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_project_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 ProjectFilter
+
+
+@cli.group(cls=TagGroup, tag=CliCategories.MANAGEMENT_TOOLS)
+def project() -> None:
+    """Commands for project management."""
+
+
+@project.command("list")
+@list_options(ProjectFilter)
+@click.pass_context
+def list_projects(ctx: click.Context, **kwargs: Any) -> None:
+    """List all projects.
+
+    Args:
+        ctx: The click context object
+        **kwargs: Keyword arguments to filter the list of projects.
+    """
+    check_zenml_pro_project_availability()
+    client = Client()
+    with console.status("Listing projects...\n"):
+        projects = client.list_projects(**kwargs)
+        if projects:
+            cli_utils.print_pydantic_models(
+                projects,
+                exclude_columns=["id", "created", "updated"],
+                active_models=[Client().active_project],
+                show_active=not is_sorted_or_filtered(ctx),
+            )
+        else:
+            cli_utils.declare("No projects found for the given filter.")
+
+
+@project.command("register")
+@click.option(
+    "--set",
+    "set_project",
+    is_flag=True,
+    help="Immediately set this project as active.",
+    type=click.BOOL,
+)
+@click.option(
+    "--display-name",
+    "display_name",
+    type=str,
+    required=False,
+    help="The display name of the project.",
+)
+@click.argument("project_name", type=str, required=True)
+def register_project(
+    project_name: str,
+    set_project: bool = False,
+    display_name: Optional[str] = None,
+) -> None:
+    """Register a new project.
+
+    Args:
+        project_name: The name of the project to register.
+        set_project: Whether to set the project as active.
+        display_name: The display name of the project.
+    """
+    check_zenml_pro_project_availability()
+    client = Client()
+    with console.status("Creating project...\n"):
+        try:
+            client.create_project(
+                project_name,
+                description="",
+                display_name=display_name,
+            )
+            cli_utils.declare("Project created successfully.")
+        except Exception as e:
+            cli_utils.error(str(e))
+
+    if set_project:
+        client.set_active_project(project_name)
+        cli_utils.declare(f"The active project has been set to {project_name}")
+
+
+@project.command("set")
+@click.argument("project_name_or_id", type=str, required=True)
+def set_project(project_name_or_id: str) -> None:
+    """Set the active project.
+
+    Args:
+        project_name_or_id: The name or ID of the project to set as active.
+    """
+    check_zenml_pro_project_availability()
+    client = Client()
+    with console.status("Setting project...\n"):
+        try:
+            client.set_active_project(project_name_or_id)
+            cli_utils.declare(
+                f"The active project has been set to {project_name_or_id}"
+            )
+        except Exception as e:
+            cli_utils.error(str(e))
+
+
+@project.command("describe")
+@click.argument("project_name_or_id", type=str, required=False)
+def describe_project(project_name_or_id: Optional[str] = None) -> None:
+    """Get the project.
+
+    Args:
+        project_name_or_id: The name or ID of the project to set as active.
+    """
+    check_zenml_pro_project_availability()
+    client = Client()
+    if not project_name_or_id:
+        active_project = client.active_project
+        cli_utils.print_pydantic_models(
+            [active_project], exclude_columns=["created", "updated"]
+        )
+    else:
+        try:
+            project_ = client.get_project(project_name_or_id)
+        except KeyError as err:
+            cli_utils.error(str(err))
+        else:
+            cli_utils.print_pydantic_models(
+                [project_], exclude_columns=["created", "updated"]
+            )
+
+
+@project.command("delete")
+@click.argument("project_name_or_id", type=str, required=True)
+def delete_project(project_name_or_id: str) -> None:
+    """Delete a project.
+
+    Args:
+        project_name_or_id: The name or ID of the project to delete.
+    """
+    check_zenml_pro_project_availability()
+    client = Client()
+    with console.status("Deleting project...\n"):
+        try:
+            client.delete_project(project_name_or_id)
+            cli_utils.declare(
+                f"Project '{project_name_or_id}' deleted successfully."
+            )
+        except Exception as e:
+            cli_utils.error(str(e))

zenml/cli/server.py

@@ -220,7 +220,7 @@ def status() -> None:
                 )
                 if pro_credentials:
                     pro_client = ZenMLProClient(pro_credentials.url)
-                    pro_servers = pro_client.tenant.list(
+                    pro_servers = pro_client.workspace.list(
                         url=store_cfg.url, member_only=True
                     )
                     if pro_servers:
@@ -575,7 +575,7 @@ def server_list(
     from zenml.login.credentials_store import get_credentials_store
     from zenml.login.pro.client import ZenMLProClient
     from zenml.login.pro.constants import ZENML_PRO_API_URL
-    from zenml.login.pro.tenant.models import TenantRead, TenantStatus
+    from zenml.login.pro.workspace.models import WorkspaceRead, WorkspaceStatus
 
     pro_api_url = pro_api_url or ZENML_PRO_API_URL
     pro_api_url = pro_api_url.rstrip("/")
@@ -601,10 +601,10 @@ def server_list(
         # that the user has never connected to (and are therefore not stored in
         # the credentials store).
 
-        accessible_pro_servers: List[TenantRead] = []
+        accessible_pro_servers: List[WorkspaceRead] = []
         try:
             client = ZenMLProClient(pro_api_url)
-            accessible_pro_servers = client.tenant.list(member_only=not all)
+            accessible_pro_servers = client.workspace.list(member_only=not all)
         except AuthorizationException as e:
             cli_utils.warning(f"ZenML Pro authorization error: {e}")
 
@@ -638,7 +638,7 @@ def server_list(
             accessible_pro_servers = [
                 s
                 for s in accessible_pro_servers
-                if s.status == TenantStatus.AVAILABLE
+                if s.status == WorkspaceStatus.AVAILABLE
             ]
 
         if not accessible_pro_servers:

zenml/cli/service_accounts.py

@@ -410,7 +410,6 @@ def list_api_keys(service_account_name_or_id: str, **kwargs: Any) -> None:
             exclude_columns=[
                 "created",
                 "updated",
-                "workspace",
                 "key",
                 "retain_period_minutes",
             ],

zenml/cli/service_connectors.py

@@ -1902,29 +1902,28 @@ def login_service_connector(
     "list-resources",
     help="""List all resources accessible by service connectors.
 
-This command can be used to list all resources that can be accessed by service
-connectors configured in your workspace. You can filter the list by connector
+This command can be used to list all resources that can be accessed by the
+currently registered service connectors. You can filter the list by connector
 type and/or resource type.
 
 Use this command to answer questions like:
 
 - show a list of all Kubernetes clusters that can be accessed by way of service
-connectors configured in my workspace
-- show a list of all connectors configured for my workspace along with all the
-resources they can access or the error state they are in, if any
+connectors
+- show a list of all connectors along with all the resources they can access or
+the error state they are in, if any
 
-NOTE: since this command exercises all service connectors in your workspace, it
-may take a while to complete.
+NOTE: since this command exercises all service connectors currently registered
+with ZenML, it may take a while to complete.
 
 Examples:
 
-- show a list of all S3 buckets that can be accessed by service connectors
-configured in your workspace:
+- show a list of all S3 buckets that can be accessed by service connectors:
 
     $ zenml service-connector list-resources --resource-type s3-bucket
 
-- show a list of all resources that the AWS connectors in your workspace can
-access:
+- show a list of all resources that the AWS connectors currently registered
+with ZenML can access:
 
     $ zenml service-connector list-resources --connector-type aws
     
@@ -1982,10 +1981,10 @@ def list_service_connector_resources(
     if not resource_type and not resource_id:
         cli_utils.warning(
             "Fetching all service connector resources can take a long time, "
-            "depending on the number of connectors configured in your "
-            "workspace. Consider using the '--connector-type', "
-            "'--resource-type' and '--resource-id' options to narrow down the "
-            "list of resources to fetch."
+            "depending on the number of connectors currently registered with "
+            "ZenML. Consider using the '--connector-type', '--resource-type' "
+            "and '--resource-id' options to narrow down the list of resources "
+            "to fetch."
         )
 
     with console.status(
@@ -2030,7 +2029,7 @@ def list_service_connector_resources(
 
     click.echo(
         f"The {resource_str} can be accessed by"
-        f"{connector_str} service connectors configured in your workspace:"
+        f"{connector_str} service connectors:"
     )
 
     cli_utils.print_service_connector_resource_table(

zenml/cli/stack.py

@@ -503,7 +503,6 @@ def register_stack(
         try:
             created_stack = client.zen_store.create_stack(
                 stack=StackRequest(
-                    workspace=client.active_workspace.id,
                     name=stack_name,
                     components=components,
                     service_connectors=[service_connector]
@@ -1913,7 +1912,6 @@ def _get_stack_component_info(
                 "Enter the subscription ID:"
             )
             config["resource_group"] = Prompt.ask("Enter the resource group:")
-            config["workspace"] = Prompt.ask("Enter the workspace name:")
         elif flavor == "vertex":
             config["location"] = query_region(
                 StackDeploymentProvider.GCP, "Vertex AI job"

zenml/cli/stack_components.py

@@ -1424,8 +1424,8 @@ def connect_stack_component_with_service_connector(
 
             cli_utils.error(
                 f"No compatible valid resources were found for the "
-                f"'{component_model.name}' {display_name} in your "
-                f"workspace. {additional_info}You can create a new "
+                f"'{component_model.name}' {display_name}. "
+                f"{additional_info}You can create a new "
                 "connector using the 'zenml service-connector register' "
                 "command or list the compatible resources using the "
                 f"'zenml service-connector list-resources{command_args}' "

zenml/cli/utils.py

@@ -2268,12 +2268,12 @@ def print_pipeline_runs_table(
     print_table(runs_dicts)
 
 
-def check_zenml_pro_workspace_availability() -> None:
-    """Check if the ZenML Pro workspace feature is available."""
+def check_zenml_pro_project_availability() -> None:
+    """Check if the ZenML Pro project feature is available."""
     client = Client()
     if not client.zen_store.get_store_info().is_pro_server():
         warning(
-            "The ZenML workspace feature is available only on ZenML Pro. "
+            "The ZenML projects feature is available only on ZenML Pro. "
             "Please visit https://zenml.io/pro to learn more."
         )