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

zenml/zen_server/routers/server_endpoints.py

@@ -32,6 +32,7 @@ from zenml.enums import AuthScheme
 from zenml.exceptions import IllegalOperationError
 from zenml.models import (
     ComponentFilter,
+    ProjectFilter,
     ServerActivationRequest,
     ServerLoadInfo,
     ServerModel,
@@ -40,7 +41,6 @@ from zenml.models import (
     ServerStatistics,
     StackFilter,
     UserResponse,
-    WorkspaceFilter,
 )
 from zenml.zen_server.auth import AuthContext, authorize
 from zenml.zen_server.exceptions import error_response
@@ -267,10 +267,10 @@ def get_server_statistics(
         ),
     )
 
-    workspace_filter = WorkspaceFilter()
-    workspace_filter.configure_rbac(
+    project_filter = ProjectFilter()
+    project_filter.configure_rbac(
         authenticated_user_id=user_id,
-        id=get_allowed_resource_ids(resource_type=ResourceType.WORKSPACE),
+        id=get_allowed_resource_ids(resource_type=ResourceType.PROJECT),
     )
 
     stack_filter = StackFilter()
@@ -284,5 +284,5 @@ def get_server_statistics(
         components=zen_store().count_stack_components(
             filter_model=component_filter
         ),
-        workspaces=zen_store().count_workspaces(filter_model=workspace_filter),
+        projects=zen_store().count_projects(filter_model=project_filter),
     )

zenml/zen_server/routers/service_connectors_endpoints.py

@@ -59,9 +59,7 @@ from zenml.zen_server.rbac.utils import (
     verify_permission,
     verify_permission_for_model,
 )
-from zenml.zen_server.routers.workspaces_endpoints import (
-    router as workspace_router,
-)
+from zenml.zen_server.routers.projects_endpoints import workspace_router
 from zenml.zen_server.utils import (
     handle_exceptions,
     make_dependable,
@@ -88,7 +86,7 @@ types_router = APIRouter(
 # TODO: the workspace scoped endpoint is only kept for dashboard compatibility
 # and can be removed after the migration
 @workspace_router.post(
-    "/{workspace_name_or_id}" + SERVICE_CONNECTORS,
+    "/{project_name_or_id}" + SERVICE_CONNECTORS,
     responses={401: error_response, 409: error_response, 422: error_response},
     deprecated=True,
     tags=["service_connectors"],
@@ -96,14 +94,14 @@ types_router = APIRouter(
 @handle_exceptions
 def create_service_connector(
     connector: ServiceConnectorRequest,
-    workspace_name_or_id: Optional[Union[str, UUID]] = None,
+    project_name_or_id: Optional[Union[str, UUID]] = None,
     _: AuthContext = Security(authorize),
 ) -> ServiceConnectorResponse:
     """Creates a service connector.
 
     Args:
         connector: Service connector to register.
-        workspace_name_or_id: Optional name or ID of the workspace.
+        project_name_or_id: Optional name or ID of the project.
 
     Returns:
         The created service connector.
@@ -121,7 +119,7 @@ def create_service_connector(
 # TODO: the workspace scoped endpoint is only kept for dashboard compatibility
 # and can be removed after the migration
 @workspace_router.get(
-    "/{workspace_name_or_id}" + SERVICE_CONNECTORS,
+    "/{project_name_or_id}" + SERVICE_CONNECTORS,
     responses={401: error_response, 404: error_response, 422: error_response},
     deprecated=True,
     tags=["service_connectors"],
@@ -131,17 +129,17 @@ def list_service_connectors(
     connector_filter_model: ServiceConnectorFilter = Depends(
         make_dependable(ServiceConnectorFilter)
     ),
-    workspace_name_or_id: Optional[Union[str, UUID]] = None,
+    project_name_or_id: Optional[Union[str, UUID]] = None,
     expand_secrets: bool = True,
     hydrate: bool = False,
     _: AuthContext = Security(authorize),
 ) -> Page[ServiceConnectorResponse]:
-    """Get a list of all service connectors, optionally filtered by workspace.
+    """Get a list of all service connectors.
 
     Args:
         connector_filter_model: Filter model used for pagination, sorting,
             filtering
-        workspace_name_or_id: Optional name or ID of the workspace to filter by.
+        project_name_or_id: Optional name or ID of the project to filter by.
         expand_secrets: Whether to expand secrets or not.
         hydrate: Flag deciding whether to hydrate the output model(s)
             by including metadata fields in the response.
@@ -318,7 +316,7 @@ def validate_and_verify_service_connector_config(
 # TODO: the workspace scoped endpoint is only kept for dashboard compatibility
 # and can be removed after the migration
 @workspace_router.get(
-    "/{workspace_name_or_id}" + SERVICE_CONNECTOR_RESOURCES,
+    "/{project_name_or_id}" + SERVICE_CONNECTOR_RESOURCES,
     responses={401: error_response, 404: error_response, 422: error_response},
     deprecated=True,
     tags=["service_connectors"],
@@ -328,7 +326,7 @@ def list_service_connector_resources(
     filter_model: ServiceConnectorFilter = Depends(
         make_dependable(ServiceConnectorFilter)
     ),
-    workspace_name_or_id: Optional[Union[str, UUID]] = None,
+    project_name_or_id: Optional[Union[str, UUID]] = None,
     auth_context: AuthContext = Security(authorize),
 ) -> List[ServiceConnectorResourcesModel]:
     """List resources that can be accessed by service connectors.
@@ -336,7 +334,7 @@ def list_service_connector_resources(
     Args:
         filter_model: The filter model to use when fetching service
             connectors.
-        workspace_name_or_id: Optional name or ID of the workspace.
+        project_name_or_id: Optional name or ID of the project.
         auth_context: Authentication context.
 
     Returns:

zenml/zen_server/routers/service_endpoints.py

@@ -36,9 +36,7 @@ from zenml.zen_server.rbac.endpoint_utils import (
     verify_permissions_and_update_entity,
 )
 from zenml.zen_server.rbac.models import ResourceType
-from zenml.zen_server.routers.workspaces_endpoints import (
-    router as workspace_router,
-)
+from zenml.zen_server.routers.projects_endpoints import workspace_router
 from zenml.zen_server.utils import (
     handle_exceptions,
     make_dependable,
@@ -59,7 +57,7 @@ router = APIRouter(
 # TODO: the workspace scoped endpoint is only kept for dashboard compatibility
 # and can be removed after the migration
 @workspace_router.post(
-    "/{workspace_name_or_id}" + SERVICES,
+    "/{project_name_or_id}" + SERVICES,
     responses={401: error_response, 409: error_response, 422: error_response},
     deprecated=True,
     tags=["services"],
@@ -67,21 +65,21 @@ router = APIRouter(
 @handle_exceptions
 def create_service(
     service: ServiceRequest,
-    workspace_name_or_id: Optional[Union[str, UUID]] = None,
+    project_name_or_id: Optional[Union[str, UUID]] = None,
     _: AuthContext = Security(authorize),
 ) -> ServiceResponse:
     """Creates a new service.
 
     Args:
         service: The service to create.
-        workspace_name_or_id: Optional name or ID of the workspace.
+        project_name_or_id: Optional name or ID of the project.
 
     Returns:
         The created service.
     """
-    if workspace_name_or_id:
-        workspace = zen_store().get_workspace(workspace_name_or_id)
-        service.workspace = workspace.id
+    if project_name_or_id:
+        project = zen_store().get_project(project_name_or_id)
+        service.project = project.id
 
     return verify_permissions_and_create_entity(
         request_model=service,

zenml/zen_server/routers/stack_components_endpoints.py

@@ -38,9 +38,7 @@ from zenml.zen_server.rbac.endpoint_utils import (
 )
 from zenml.zen_server.rbac.models import Action, ResourceType
 from zenml.zen_server.rbac.utils import verify_permission_for_model
-from zenml.zen_server.routers.workspaces_endpoints import (
-    router as workspace_router,
-)
+from zenml.zen_server.routers.projects_endpoints import workspace_router
 from zenml.zen_server.utils import (
     handle_exceptions,
     make_dependable,
@@ -67,7 +65,7 @@ types_router = APIRouter(
 # TODO: the workspace scoped endpoint is only kept for dashboard compatibility
 # and can be removed after the migration
 @workspace_router.post(
-    "/{workspace_name_or_id}" + STACK_COMPONENTS,
+    "/{project_name_or_id}" + STACK_COMPONENTS,
     responses={401: error_response, 409: error_response, 422: error_response},
     deprecated=True,
     tags=["stack_components"],
@@ -75,14 +73,14 @@ types_router = APIRouter(
 @handle_exceptions
 def create_stack_component(
     component: ComponentRequest,
-    workspace_name_or_id: Optional[Union[str, UUID]] = None,
+    project_name_or_id: Optional[Union[str, UUID]] = None,
     _: AuthContext = Security(authorize),
 ) -> ComponentResponse:
-    """Creates a stack component, optionally in a specific workspace.
+    """Creates a stack component.
 
     Args:
         component: Stack component to register.
-        workspace_name_or_id: Optional name or ID of the workspace.
+        project_name_or_id: Optional name or ID of the project.
 
     Returns:
         The created stack component.
@@ -117,7 +115,7 @@ def create_stack_component(
 # TODO: the workspace scoped endpoint is only kept for dashboard compatibility
 # and can be removed after the migration
 @workspace_router.get(
-    "/{workspace_name_or_id}" + STACK_COMPONENTS,
+    "/{project_name_or_id}" + STACK_COMPONENTS,
     responses={401: error_response, 404: error_response, 422: error_response},
     deprecated=True,
     tags=["stack_components"],
@@ -127,16 +125,16 @@ def list_stack_components(
     component_filter_model: ComponentFilter = Depends(
         make_dependable(ComponentFilter)
     ),
-    workspace_name_or_id: Optional[Union[str, UUID]] = None,
+    project_name_or_id: Optional[Union[str, UUID]] = None,
     hydrate: bool = False,
     _: AuthContext = Security(authorize),
 ) -> Page[ComponentResponse]:
-    """Get a list of all stack components, optionally filtered by workspace.
+    """Get a list of all stack components.
 
     Args:
         component_filter_model: Filter model used for pagination, sorting,
             filtering.
-        workspace_name_or_id: Optional name or ID of the workspace to filter by.
+        project_name_or_id: Optional name or ID of the project to filter by.
         hydrate: Flag deciding whether to hydrate the output model(s)
             by including metadata fields in the response.
 

zenml/zen_server/routers/stacks_endpoints.py

@@ -40,9 +40,7 @@ from zenml.zen_server.rbac.utils import (
     verify_permission,
     verify_permission_for_model,
 )
-from zenml.zen_server.routers.workspaces_endpoints import (
-    router as workspace_router,
-)
+from zenml.zen_server.routers.projects_endpoints import workspace_router
 from zenml.zen_server.utils import (
     handle_exceptions,
     make_dependable,
@@ -63,7 +61,7 @@ router = APIRouter(
 # TODO: the workspace scoped endpoint is only kept for dashboard compatibility
 # and can be removed after the migration
 @workspace_router.post(
-    "/{workspace_name_or_id}" + STACKS,
+    "/{project_name_or_id}" + STACKS,
     responses={401: error_response, 409: error_response, 422: error_response},
     deprecated=True,
     tags=["stacks"],
@@ -71,14 +69,14 @@ router = APIRouter(
 @handle_exceptions
 def create_stack(
     stack: StackRequest,
-    workspace_name_or_id: Optional[Union[str, UUID]] = None,
+    project_name_or_id: Optional[Union[str, UUID]] = None,
     auth_context: AuthContext = Security(authorize),
 ) -> StackResponse:
-    """Creates a stack, optionally in a specific workspace.
+    """Creates a stack.
 
     Args:
         stack: Stack to register.
-        workspace_name_or_id: Optional name or ID of the workspace.
+        project_name_or_id: Optional name or ID of the project.
         auth_context: Authentication context.
 
     Returns:
@@ -133,22 +131,22 @@ def create_stack(
 # TODO: the workspace scoped endpoint is only kept for dashboard compatibility
 # and can be removed after the migration
 @workspace_router.get(
-    "/{workspace_name_or_id}" + STACKS,
+    "/{project_name_or_id}" + STACKS,
     responses={401: error_response, 404: error_response, 422: error_response},
     deprecated=True,
     tags=["stacks"],
 )
 @handle_exceptions
 def list_stacks(
-    workspace_name_or_id: Optional[Union[str, UUID]] = None,
+    project_name_or_id: Optional[Union[str, UUID]] = None,
     stack_filter_model: StackFilter = Depends(make_dependable(StackFilter)),
     hydrate: bool = False,
     _: AuthContext = Security(authorize),
 ) -> Page[StackResponse]:
-    """Returns all stacks, optionally filtered by workspace.
+    """Returns all stacks.
 
     Args:
-        workspace_name_or_id: Optional name or ID of the workspace to filter by.
+        project_name_or_id: Optional name or ID of the project to filter by.
         stack_filter_model: Filter model used for pagination, sorting,
             filtering.
         hydrate: Flag deciding whether to hydrate the output model(s)

zenml/zen_server/routers/steps_endpoints.py

@@ -50,7 +50,7 @@ from zenml.zen_server.rbac.utils import (
 from zenml.zen_server.utils import (
     handle_exceptions,
     make_dependable,
-    set_filter_workspace_scope,
+    set_filter_project_scope,
     zen_store,
 )
 
@@ -85,14 +85,14 @@ def list_run_steps(
     Returns:
         The run steps according to query filters.
     """
-    # A workspace scoped request must always be scoped to a specific
-    # workspace. This is required for the RBAC check to work.
-    set_filter_workspace_scope(step_run_filter_model)
-    assert isinstance(step_run_filter_model.workspace, UUID)
+    # A project scoped request must always be scoped to a specific
+    # project. This is required for the RBAC check to work.
+    set_filter_project_scope(step_run_filter_model)
+    assert isinstance(step_run_filter_model.project, UUID)
 
     allowed_pipeline_run_ids = get_allowed_resource_ids(
         resource_type=ResourceType.PIPELINE_RUN,
-        workspace_id=step_run_filter_model.workspace,
+        project_id=step_run_filter_model.project,
     )
     step_run_filter_model.configure_rbac(
         authenticated_user_id=auth_context.user.id,

zenml/zen_server/routers/users_endpoints.py

@@ -33,12 +33,12 @@ from zenml.exceptions import AuthorizationException, IllegalOperationError
 from zenml.logger import get_logger
 from zenml.models import (
     Page,
+    ProjectScopedResponse,
     UserAuthModel,
     UserFilter,
     UserRequest,
     UserResponse,
     UserUpdate,
-    WorkspaceScopedResponse,
 )
 from zenml.zen_server.auth import (
     AuthContext,
@@ -47,9 +47,6 @@ from zenml.zen_server.auth import (
 )
 from zenml.zen_server.exceptions import error_response
 from zenml.zen_server.rate_limit import RequestLimiter
-from zenml.zen_server.rbac.endpoint_utils import (
-    verify_permissions_and_get_entity,
-)
 from zenml.zen_server.rbac.models import Action, Resource, ResourceType
 from zenml.zen_server.rbac.utils import (
     dehydrate_page,
@@ -757,12 +754,12 @@ if server_config().rbac_enabled:
                 "not exist."
             )
 
-        workspace_id = None
-        if isinstance(model, WorkspaceScopedResponse):
-            workspace_id = model.workspace.id
+        project_id = None
+        if isinstance(model, ProjectScopedResponse):
+            project_id = model.project.id
 
         resource = Resource(
-            type=resource_type, id=resource_id, workspace_id=workspace_id
+            type=resource_type, id=resource_id, project_id=project_id
         )
 
         verify_permission_for_model(model=model, action=Action.SHARE)
@@ -776,38 +773,3 @@ if server_config().rbac_enabled:
             resource=resource,
             actions=[Action(action) for action in actions],
         )
-
-
-@current_user_router.put(
-    "/default-workspace",
-    responses={
-        401: error_response,
-        404: error_response,
-        422: error_response,
-    },
-)
-@handle_exceptions
-def update_user_default_workspace(
-    workspace_name_or_id: Union[str, UUID],
-    auth_context: AuthContext = Security(authorize),
-) -> UserResponse:
-    """Updates the default workspace of the current user.
-
-    Args:
-        workspace_name_or_id: Name or ID of the workspace.
-        auth_context: Authentication context.
-
-    Returns:
-        The updated user.
-    """
-    workspace = verify_permissions_and_get_entity(
-        id=workspace_name_or_id,
-        get_method=zen_store().get_workspace,
-    )
-
-    user = zen_store().update_user(
-        user_id=auth_context.user.id,
-        user_update=UserUpdate(default_workspace_id=workspace.id),
-    )
-
-    return dehydrate_response_model(user)

zenml/zen_server/template_execution/utils.py

@@ -18,8 +18,8 @@ from zenml.config.pipeline_run_configuration import (
 )
 from zenml.config.step_configurations import Step, StepConfiguration
 from zenml.constants import (
+    ENV_ZENML_ACTIVE_PROJECT_ID,
     ENV_ZENML_ACTIVE_STACK_ID,
-    ENV_ZENML_ACTIVE_WORKSPACE_ID,
 )
 from zenml.enums import ExecutionStatus, StackComponentType, StoreType
 from zenml.logger import get_logger
@@ -134,7 +134,7 @@ def run_template(
     ).access_token
 
     environment = {
-        ENV_ZENML_ACTIVE_WORKSPACE_ID: str(new_deployment.workspace.id),
+        ENV_ZENML_ACTIVE_PROJECT_ID: str(new_deployment.project.id),
         ENV_ZENML_ACTIVE_STACK_ID: str(stack.id),
         "ZENML_VERSION": zenml_version,
         "ZENML_STORE_URL": server_url,
@@ -407,7 +407,7 @@ def deployment_request_from_template(
     assert deployment.stack
     assert deployment.build
     deployment_request = PipelineDeploymentRequest(
-        workspace=deployment.workspace.id,
+        project=deployment.project.id,
         run_name_template=config.run_name
         or get_default_run_name(pipeline_name=pipeline_configuration.name),
         pipeline_configuration=pipeline_configuration,
@@ -463,7 +463,7 @@ def get_pipeline_run_analytics_metadata(
     }
 
     return {
-        "workspace_id": deployment.workspace.id,
+        "project_id": deployment.project.id,
         "store_type": "rest",  # This method is called from within a REST endpoint
         **stack_metadata,
         "total_steps": len(deployment.step_configurations),

zenml/zen_server/utils.py

@@ -46,7 +46,7 @@ from zenml.constants import (
 from zenml.enums import StoreType
 from zenml.exceptions import IllegalOperationError, OAuthError
 from zenml.logger import get_logger
-from zenml.models.v2.base.scoped import WorkspaceScopedFilter
+from zenml.models.v2.base.scoped import ProjectScopedFilter
 from zenml.plugins.plugin_flavor_registry import PluginFlavorRegistry
 from zenml.zen_server.cache import MemoryCache
 from zenml.zen_server.deploy.deployment import (
@@ -640,19 +640,19 @@ def get_zenml_headers() -> Dict[str, str]:
     return headers
 
 
-def set_filter_workspace_scope(
-    filter_model: WorkspaceScopedFilter,
-    workspace_name_or_id: Optional[Union[UUID, str]] = None,
+def set_filter_project_scope(
+    filter_model: ProjectScopedFilter,
+    project_name_or_id: Optional[Union[UUID, str]] = None,
 ) -> None:
-    """Set the workspace scope of the filter model.
+    """Set the project scope of the filter model.
 
     Args:
         filter_model: The filter model to set the scope for.
-        workspace_name_or_id: The workspace to set the scope for. If not
-            provided, the workspace scope is determined from the request
-            workspace filter or the default workspace, in that order.
+        project_name_or_id: The project to set the scope for. If not
+            provided, the project scope is determined from the request
+            project filter or the default project, in that order.
     """
-    zen_store().set_filter_workspace_id(
+    zen_store().set_filter_project_id(
         filter_model=filter_model,
-        workspace_name_or_id=workspace_name_or_id,
+        project_name_or_id=project_name_or_id,
     )

zenml/zen_server/zen_server_api.py

@@ -73,6 +73,7 @@ from zenml.zen_server.routers import (
     pipeline_deployments_endpoints,
     pipelines_endpoints,
     plugin_endpoints,
+    projects_endpoints,
     run_metadata_endpoints,
     run_templates_endpoints,
     runs_endpoints,
@@ -91,7 +92,6 @@ from zenml.zen_server.routers import (
     triggers_endpoints,
     users_endpoints,
     webhook_endpoints,
-    workspaces_endpoints,
 )
 from zenml.zen_server.secure_headers import (
     initialize_secure_headers,
@@ -495,7 +495,8 @@ app.include_router(triggers_endpoints.router)
 app.include_router(users_endpoints.router)
 app.include_router(users_endpoints.current_user_router)
 app.include_router(webhook_endpoints.router)
-app.include_router(workspaces_endpoints.router)
+app.include_router(projects_endpoints.workspace_router)
+app.include_router(projects_endpoints.router)
 
 # When the auth scheme is set to EXTERNAL, users cannot be managed via the
 # API.