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

zenml/zen_stores/zen_store_interface.py

@@ -90,6 +90,10 @@ from zenml.models import (
     PipelineRunResponse,
     PipelineRunUpdate,
     PipelineUpdate,
+    ProjectFilter,
+    ProjectRequest,
+    ProjectResponse,
+    ProjectUpdate,
     RunMetadataRequest,
     RunTemplateFilter,
     RunTemplateRequest,
@@ -146,10 +150,6 @@ from zenml.models import (
     UserRequest,
     UserResponse,
     UserUpdate,
-    WorkspaceFilter,
-    WorkspaceRequest,
-    WorkspaceResponse,
-    WorkspaceUpdate,
 )
 
 
@@ -196,24 +196,19 @@ class ZenStoreInterface(ABC):
       them call the generic get or list method in this interface.
       * keep the logic required to convert between ZenML domain Model classes
       and internal store representations outside the ZenML domain Model classes
-      * methods for resources that have two or more unique keys (e.g. a Workspace
+      * methods for resources that have two or more unique keys (e.g. a project
       is uniquely identified by its name as well as its UUID) should reflect
       that in the method variants and/or method arguments:
         * methods that take in a resource identifier as argument should accept
-        all variants of the identifier (e.g. `workspace_name_or_uuid` for methods
-        that get/list/update/delete Workspaces)
+        all variants of the identifier (e.g. `project_name_or_uuid` for methods
+        that get/list/update/delete projects)
         * if a compound key is involved, separate get methods should be
         implemented (e.g. `get_pipeline` to get a pipeline by ID and
-        `get_pipeline_in_workspace` to get a pipeline by its name and the ID of
-        the workspace it belongs to)
+        `get_pipeline_in_project` to get a pipeline by its name and the ID of
+        the project it belongs to)
       * methods for resources that are scoped as children of other resources
-      (e.g. a Stack is always owned by a Workspace) should reflect the
-      key(s) of the parent resource in the provided methods and method
-      arguments:
-        * create methods should take the parent resource UUID(s) as an argument
-        (e.g. `create_stack` takes in the workspace ID)
-        * get methods should be provided to retrieve a resource by the compound
-        key that includes the parent resource key(s)
+      (e.g. a pipeline is always owned by a project) should reflect the
+      key(s) of the parent resource in the provided method arguments:
         * list methods should feature optional filter arguments that reflect
         the parent resource key(s)
     """
@@ -746,13 +741,13 @@ class ZenStoreInterface(ABC):
     @abstractmethod
     def prune_artifact_versions(
         self,
-        workspace_name_or_id: Union[str, UUID],
+        project_name_or_id: Union[str, UUID],
         only_versions: bool = True,
     ) -> None:
         """Prunes unused artifact versions and their artifacts.
 
         Args:
-            workspace_name_or_id: The workspace name or ID to prune artifact
+            project_name_or_id: The project name or ID to prune artifact
                 versions for.
             only_versions: Only delete artifact versions, keeping artifacts
         """
@@ -895,7 +890,7 @@ class ZenStoreInterface(ABC):
 
         Raises:
             EntityExistsError: If a stack component with the same name
-                and type is already owned by this user in this workspace.
+                and type already exists.
         """
 
     @abstractmethod
@@ -1048,7 +1043,7 @@ class ZenStoreInterface(ABC):
 
         Raises:
             EntityExistsError: If a flavor with the same name and type
-                is already owned by this user in this workspace.
+                already exists.
         """
 
     @abstractmethod
@@ -1136,7 +1131,7 @@ class ZenStoreInterface(ABC):
         self,
         pipeline: PipelineRequest,
     ) -> PipelineResponse:
-        """Creates a new pipeline in a workspace.
+        """Creates a new pipeline.
 
         Args:
             pipeline: The pipeline to create.
@@ -1145,7 +1140,6 @@ class ZenStoreInterface(ABC):
             The newly created pipeline.
 
         Raises:
-            KeyError: if the workspace does not exist.
             EntityExistsError: If an identical pipeline already exists.
         """
 
@@ -1222,7 +1216,7 @@ class ZenStoreInterface(ABC):
         self,
         build: PipelineBuildRequest,
     ) -> PipelineBuildResponse:
-        """Creates a new build in a workspace.
+        """Creates a new build.
 
         Args:
             build: The build to create.
@@ -1231,7 +1225,6 @@ class ZenStoreInterface(ABC):
             The newly created build.
 
         Raises:
-            KeyError: If the workspace does not exist.
             EntityExistsError: If an identical build already exists.
         """
 
@@ -1289,7 +1282,7 @@ class ZenStoreInterface(ABC):
         self,
         deployment: PipelineDeploymentRequest,
     ) -> PipelineDeploymentResponse:
-        """Creates a new deployment in a workspace.
+        """Creates a new deployment.
 
         Args:
             deployment: The deployment to create.
@@ -1298,7 +1291,6 @@ class ZenStoreInterface(ABC):
             The newly created deployment.
 
         Raises:
-            KeyError: If the workspace does not exist.
             EntityExistsError: If an identical deployment already exists.
         """
 
@@ -1666,7 +1658,7 @@ class ZenStoreInterface(ABC):
         schedule_filter_model: ScheduleFilter,
         hydrate: bool = False,
     ) -> Page[ScheduleResponse]:
-        """List all schedules in the workspace.
+        """List all schedules.
 
         Args:
             schedule_filter_model: All filter parameters including pagination
@@ -1720,10 +1712,8 @@ class ZenStoreInterface(ABC):
         The new secret is also validated against the scoping rules enforced in
         the secrets store:
 
-          - only one workspace-scoped secret with the given name can exist
-            in the target workspace.
-          - only one user-scoped secret with the given name can exist in the
-            target workspace for the target user.
+          - only one private secret with the given name can exist.
+          - only one public secret with the given name can exist.
 
         Args:
             secret: The secret to create.
@@ -1732,7 +1722,7 @@ class ZenStoreInterface(ABC):
             The newly created secret.
 
         Raises:
-            KeyError: if the user or workspace does not exist.
+            KeyError: if the user does not exist.
             EntityExistsError: If a secret with the same name already exists in
                 the same scope.
         """
@@ -1794,10 +1784,8 @@ class ZenStoreInterface(ABC):
         If the update includes a change of name or scope, the scoping rules
         enforced in the secrets store are used to validate the update:
 
-          - only one workspace-scoped secret with the given name can exist
-            in the target workspace.
-          - only one user-scoped secret with the given name can exist in the
-            target workspace for the target user.
+          - only one private secret with the given name can exist.
+          - only one public secret with the given name can exist.
 
         Args:
             secret_id: The ID of the secret to be updated.
@@ -1973,7 +1961,7 @@ class ZenStoreInterface(ABC):
 
         Raises:
             EntityExistsError: If a service connector with the given name
-                is already owned by this user in this workspace.
+                already exists.
         """
 
     @abstractmethod
@@ -2606,86 +2594,84 @@ class ZenStoreInterface(ABC):
             KeyError: If no user with the given ID exists.
         """
 
-    # -------------------- Workspaces --------------------
+    # -------------------- Projects --------------------
 
     @abstractmethod
-    def create_workspace(
-        self, workspace: WorkspaceRequest
-    ) -> WorkspaceResponse:
-        """Creates a new workspace.
+    def create_project(self, project: ProjectRequest) -> ProjectResponse:
+        """Creates a new project.
 
         Args:
-            workspace: The workspace to create.
+            project: The project to create.
 
         Returns:
-            The newly created workspace.
+            The newly created project.
 
         Raises:
-            EntityExistsError: If a workspace with the given name already exists.
+            EntityExistsError: If a project with the given name already exists.
         """
 
     @abstractmethod
-    def get_workspace(
-        self, workspace_name_or_id: Union[UUID, str], hydrate: bool = True
-    ) -> WorkspaceResponse:
-        """Get an existing workspace by name or ID.
+    def get_project(
+        self, project_name_or_id: Union[UUID, str], hydrate: bool = True
+    ) -> ProjectResponse:
+        """Get an existing project by name or ID.
 
         Args:
-            workspace_name_or_id: Name or ID of the workspace to get.
+            project_name_or_id: Name or ID of the project to get.
             hydrate: Flag deciding whether to hydrate the output model(s)
                 by including metadata fields in the response.
 
         Returns:
-            The requested workspace.
+            The requested project.
 
         Raises:
-            KeyError: If there is no such workspace.
+            KeyError: If there is no such project.
         """
 
     @abstractmethod
-    def list_workspaces(
+    def list_projects(
         self,
-        workspace_filter_model: WorkspaceFilter,
+        project_filter_model: ProjectFilter,
         hydrate: bool = False,
-    ) -> Page[WorkspaceResponse]:
-        """List all workspace matching the given filter criteria.
+    ) -> Page[ProjectResponse]:
+        """List all projects matching the given filter criteria.
 
         Args:
-            workspace_filter_model: All filter parameters including pagination
+            project_filter_model: All filter parameters including pagination
                 params.
             hydrate: Flag deciding whether to hydrate the output model(s)
                 by including metadata fields in the response.
 
         Returns:
-            A list of all workspace matching the filter criteria.
+            A list of all projects matching the filter criteria.
         """
 
     @abstractmethod
-    def update_workspace(
-        self, workspace_id: UUID, workspace_update: WorkspaceUpdate
-    ) -> WorkspaceResponse:
-        """Update an existing workspace.
+    def update_project(
+        self, project_id: UUID, project_update: ProjectUpdate
+    ) -> ProjectResponse:
+        """Update an existing project.
 
         Args:
-            workspace_id: The ID of the workspace to be updated.
-            workspace_update: The update to be applied to the workspace.
+            project_id: The ID of the project to be updated.
+            project_update: The update to be applied to the project.
 
         Returns:
-            The updated workspace.
+            The updated project.
 
         Raises:
-            KeyError: if the workspace does not exist.
+            KeyError: if the project does not exist.
         """
 
     @abstractmethod
-    def delete_workspace(self, workspace_name_or_id: Union[str, UUID]) -> None:
-        """Deletes a workspace.
+    def delete_project(self, project_name_or_id: Union[str, UUID]) -> None:
+        """Deletes a project.
 
         Args:
-            workspace_name_or_id: Name or ID of the workspace to delete.
+            project_name_or_id: Name or ID of the project to delete.
 
         Raises:
-            KeyError: If no workspace with the given name exists.
+            KeyError: If no project with the given name exists.
         """
 
     # -------------------- Models --------------------

{zenml_nightly-0.75.0.dev20250313.dist-info → zenml_nightly-0.75.0.dev20250315.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: zenml-nightly
-Version: 0.75.0.dev20250313
+Version: 0.75.0.dev20250315
 Summary: ZenML: Write production-ready ML code.
 License: Apache-2.0
 Keywords: machine learning,production,pipeline,mlops,devops