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

zenml/VERSION

@@ -1 +1 @@
-0.75.0.dev20250312
+0.75.0.dev20250314

zenml/__init__.py

@@ -49,9 +49,11 @@ from zenml.pipelines import get_pipeline_context, pipeline
 from zenml.steps import step, get_step_context
 from zenml.steps.utils import log_step_metadata
 from zenml.utils.metadata_utils import log_metadata
+from zenml.utils.tag_utils import Tag, add_tags, remove_tags
 from zenml.entrypoints import entrypoint
 
 __all__ = [
+    "add_tags",
     "ArtifactConfig",
     "ExternalArtifact",
     "get_pipeline_context",

zenml/analytics/context.py

@@ -118,7 +118,10 @@ class AnalyticsContext:
                     self.external_user_id = auth_context.user.external_user_id
 
                 self.external_server_id = server_config().external_server_id
+                self.project_id = None
             else:
+                from zenml.client import Client
+
                 # If the code is running on the client, use the default user.
                 active_user = gc.zen_store.get_user()
                 self.user_id = active_user.id
@@ -126,6 +129,7 @@ class AnalyticsContext:
                     active_user.is_service_account
                 )
                 self.external_user_id = active_user.external_user_id
+                self.project_id = Client().active_project.id
 
             # Fetch the `client_id`
             if self.in_server:
@@ -304,6 +308,9 @@ class AnalyticsContext:
         if self.server_metadata:
             properties.update(self.server_metadata)
 
+        if self.project_id:
+            properties.setdefault("project_id", str(self.project_id))
+
         for k, v in properties.items():
             if isinstance(v, UUID):
                 properties[k] = str(v)

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,8 +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),
-        user=Client().active_user.id,
-        workspace=Client().active_workspace.id,
+        project=Client().active_project.id,
         artifact_store_id=artifact_store.id,
         visualizations=visualizations,
         has_custom_name=has_custom_name,
@@ -350,8 +349,7 @@ def register_artifact(
         uri=folder_or_file_uri,
         materializer=source_utils.resolve(PreexistingDataMaterializer),
         data_type=source_utils.resolve(Path),
-        user=Client().active_user.id,
-        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

@@ -291,6 +291,11 @@ def connect_to_pro_server(
             login = True
 
     if login or refresh:
+        # If we reached this point, then we need to start a new login flow.
+        # 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)
         try:
             token = web_login(
                 pro_api_url=pro_api_url,
@@ -976,6 +981,7 @@ def logout(
             )
 
         pro_api_url = pro_api_url or ZENML_PRO_API_URL
+        pro_api_url = pro_api_url.rstrip("/")
         if credentials_store.has_valid_pro_authentication(pro_api_url):
             credentials_store.clear_pro_credentials(pro_api_url)
             cli_utils.declare("Logged out from ZenML Pro.")

zenml/cli/model.py

@@ -91,9 +91,7 @@ def list_models(**kwargs: Any) -> None:
     Args:
         **kwargs: Keyword arguments to filter models.
     """
-    models = Client().zen_store.list_models(
-        model_filter_model=ModelFilter(**kwargs)
-    )
+    models = Client().list_models(**kwargs)
 
     if not models:
         cli_utils.declare("No models found.")
@@ -399,24 +397,18 @@ def version() -> None:
 
 
 @cli_utils.list_options(ModelVersionFilter)
-@click.option(
-    "--model-name",
-    "-n",
-    help="The name of the parent model.",
-    type=str,
-    required=False,
-)
 @version.command("list", help="List model versions with filter.")
-def list_model_versions(model_name: str, **kwargs: Any) -> None:
+@click.argument("model_name_or_id")
+def list_model_versions(model_name_or_id: str, **kwargs: Any) -> None:
     """List model versions with filter in the Model Control Plane.
 
     Args:
-        model_name: The name of the parent model.
+        model_name_or_id: The name or ID of the parent model.
         **kwargs: Keyword arguments to filter models.
     """
-    model_versions = Client().zen_store.list_model_versions(
-        model_name_or_id=model_name,
-        model_version_filter_model=ModelVersionFilter(**kwargs),
+    model_versions = Client().list_model_versions(
+        model_name_or_id=model_name_or_id,
+        **kwargs,
     )
 
     if not model_versions:

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/secret.py

@@ -38,7 +38,6 @@ from zenml.console import console
 from zenml.constants import SECRET_VALUES
 from zenml.enums import (
     CliCategories,
-    SecretScope,
 )
 from zenml.exceptions import EntityExistsError, ZenKeyError
 from zenml.logger import get_logger
@@ -59,11 +58,12 @@ def secret() -> None:
 )
 @click.argument("name", type=click.STRING)
 @click.option(
-    "--scope",
-    "-s",
-    "scope",
-    type=click.Choice([scope.value for scope in list(SecretScope)]),
-    default=SecretScope.WORKSPACE.value,
+    "--private",
+    "-p",
+    "private",
+    is_flag=True,
+    help="Whether the secret is private. A private secret is only accessible "
+    "to the user who creates it.",
 )
 @click.option(
     "--interactive",
@@ -84,13 +84,13 @@ def secret() -> None:
 )
 @click.argument("args", nargs=-1, type=click.UNPROCESSED)
 def create_secret(
-    name: str, scope: str, interactive: bool, values: str, args: List[str]
+    name: str, private: bool, interactive: bool, values: str, args: List[str]
 ) -> None:
     """Create a secret.
 
     Args:
         name: The name of the secret to create.
-        scope: The scope of the secret to create.
+        private: Whether the secret is private.
         interactive: Whether to use interactive mode to enter the secret values.
         values: Secret key-value pairs to be passed as JSON or YAML.
         args: The arguments to pass to the secret.
@@ -152,7 +152,7 @@ def create_secret(
         with console.status(f"Saving secret `{name}`..."):
             try:
                 client.create_secret(
-                    name=name, values=parsed_args, scope=SecretScope(scope)
+                    name=name, values=parsed_args, private=private
                 )
                 declare(f"Secret '{name}' successfully created.")
             except EntityExistsError as e:
@@ -186,7 +186,7 @@ def list_secrets(**kwargs: Any) -> None:
             dict(
                 name=secret.name,
                 id=str(secret.id),
-                scope=secret.scope.value,
+                private=secret.private,
             )
             for secret in secrets.items
         ]
@@ -200,22 +200,26 @@ def list_secrets(**kwargs: Any) -> None:
     type=click.STRING,
 )
 @click.option(
-    "--scope",
-    "-s",
-    type=click.Choice([scope.value for scope in list(SecretScope)]),
-    default=None,
+    "--private",
+    "-p",
+    "private",
+    type=click.BOOL,
+    required=False,
+    help="Use this flag to explicitly fetch a private secret or a public secret.",
 )
-def get_secret(name_id_or_prefix: str, scope: Optional[str] = None) -> None:
+def get_secret(name_id_or_prefix: str, private: Optional[bool] = None) -> None:
     """Get a secret and print it to the console.
 
     Args:
         name_id_or_prefix: The name of the secret to get.
-        scope: The scope of the secret to get.
+        private: Private status of the secret to filter for.
     """
-    secret = _get_secret(name_id_or_prefix, scope)
+    secret = _get_secret(name_id_or_prefix, private)
+    scope = ""
+    if private is not None:
+        scope = "private " if private else "public "
     declare(
-        f"Fetched secret with name `{secret.name}` and ID `{secret.id}` in "
-        f"scope `{secret.scope.value}`:"
+        f"Fetched {scope}secret with name `{secret.name}` and ID `{secret.id}`:"
     )
     if not secret.secret_values:
         warning(f"Secret with name `{name_id_or_prefix}` is empty.")
@@ -224,25 +228,22 @@ def get_secret(name_id_or_prefix: str, scope: Optional[str] = None) -> None:
 
 
 def _get_secret(
-    name_id_or_prefix: str, scope: Optional[str] = None
+    name_id_or_prefix: str, private: Optional[bool] = None
 ) -> SecretResponse:
     """Get a secret with a given name, prefix or id.
 
     Args:
         name_id_or_prefix: The name of the secret to get.
-        scope: The scope of the secret to get.
+        private: Private status of the secret to filter for.
 
     Returns:
         The secret response model.
     """
     client = Client()
     try:
-        if scope:
-            return client.get_secret(
-                name_id_or_prefix=name_id_or_prefix, scope=SecretScope(scope)
-            )
-        else:
-            return client.get_secret(name_id_or_prefix=name_id_or_prefix)
+        return client.get_secret(
+            name_id_or_prefix=name_id_or_prefix, private=private
+        )
     except ZenKeyError as e:
         error(
             f"Error fetching secret with name id or prefix "
@@ -267,9 +268,12 @@ def _get_secret(
     type=click.STRING,
 )
 @click.option(
-    "--new-scope",
-    "-s",
-    type=click.Choice([scope.value for scope in list(SecretScope)]),
+    "--private",
+    "-p",
+    "private",
+    type=click.BOOL,
+    required=False,
+    help="Update the private status of the secret.",
 )
 @click.option(
     "--interactive",
@@ -293,7 +297,7 @@ def _get_secret(
 def update_secret(
     name_or_id: str,
     extra_args: List[str],
-    new_scope: Optional[str] = None,
+    private: Optional[bool] = None,
     remove_keys: List[str] = [],
     interactive: bool = False,
     values: str = "",
@@ -302,7 +306,7 @@ def update_secret(
 
     Args:
         name_or_id: The name or id of the secret to update.
-        new_scope: The new scope of the secret.
+        private: Private status of the secret to update.
         extra_args: The arguments to pass to the secret.
         interactive: Whether to use interactive mode to update the secret.
         remove_keys: The keys to remove from the secret.
@@ -331,10 +335,7 @@ def update_secret(
         except NotImplementedError as e:
             error(f"Centralized secrets management is disabled: {str(e)}")
 
-    declare(
-        f"Updating secret with name '{secret.name}' and ID '{secret.id}' in "
-        f"scope '{secret.scope.value}:"
-    )
+    declare(f"Updating secret with name '{secret.name}' and ID '{secret.id}'")
 
     if "name" in parsed_args:
         error("The word 'name' cannot be used as a key for a secret.")
@@ -388,7 +389,7 @@ def update_secret(
 
     client.update_secret(
         name_id_or_prefix=secret.id,
-        new_scope=SecretScope(new_scope) if new_scope else None,
+        update_private=private,
         add_or_update_values=secret_args_add_update,
         remove_values=remove_keys,
     )
@@ -492,10 +493,12 @@ def delete_secret(name_or_id: str, yes: bool = False) -> None:
     type=click.STRING,
 )
 @click.option(
-    "--scope",
-    "-s",
-    type=click.Choice([scope.value for scope in list(SecretScope)]),
-    default=None,
+    "--private",
+    "-p",
+    "private",
+    type=click.BOOL,
+    required=False,
+    help="Use this flag to explicitly fetch a private secret or a public secret.",
 )
 @click.option(
     "--filename",
@@ -509,7 +512,7 @@ def delete_secret(name_or_id: str, yes: bool = False) -> None:
 )
 def export_secret(
     name_id_or_prefix: str,
-    scope: Optional[str] = None,
+    private: Optional[bool] = None,
     filename: Optional[str] = None,
 ) -> None:
     """Export a secret as a YAML file.
@@ -519,12 +522,12 @@ def export_secret(
 
     Args:
         name_id_or_prefix: The name of the secret to export.
-        scope: The scope of the secret to export.
+        private: Private status of the secret to export.
         filename: The name of the file to export the secret to.
     """
     from zenml.utils.yaml_utils import write_yaml
 
-    secret = _get_secret(name_id_or_prefix=name_id_or_prefix, scope=scope)
+    secret = _get_secret(name_id_or_prefix=name_id_or_prefix, private=private)
     if not secret.secret_values:
         warning(f"Secret with name `{name_id_or_prefix}` is empty.")
         return

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",
             ],