Add the ability to store a default project for a user

src/zenml/cli/project.py

@@ -75,24 +75,32 @@ def list_projects(ctx: click.Context, /, **kwargs: Any) -> None:
     required=False,
     help="The display name of the project.",
 )
+@click.option(
+    "--set-default",
+    "set_default",
+    is_flag=True,
+    help="Set this project as the default project.",
+)
 @click.argument("project_name", type=str, required=True)
 def register_project(
     project_name: str,
     set_project: bool = False,
     display_name: Optional[str] = None,
+    set_default: bool = False,
 ) -> 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.
+        set_default: Whether to set the project as the default project.
     """
     check_zenml_pro_project_availability()
     client = Client()
     with console.status("Creating project...\n"):
         try:
-            client.create_project(
+            project = client.create_project(
                 project_name,
                 description="",
                 display_name=display_name,
@@ -105,26 +113,51 @@ def register_project(
         client.set_active_project(project_name)
         cli_utils.declare(f"The active project has been set to {project_name}")
 
+    if set_default:
+        client.update_user(
+            name_id_or_prefix=client.active_user.id,
+            updated_default_project_id=project.id,
+        )
+        cli_utils.declare(
+            f"The default 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:
+@click.option(
+    "--default",
+    "default",
+    is_flag=True,
+    help="Set this project as the default project.",
+)
+def set_project(project_name_or_id: str, default: bool = False) -> None:
     """Set the active project.
 
     Args:
         project_name_or_id: The name or ID of the project to set as active.
+        default: Whether to set the project as the default project.
     """
     check_zenml_pro_project_availability()
     client = Client()
     with console.status("Setting project...\n"):
         try:
-            client.set_active_project(project_name_or_id)
+            project = 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))
 
+    if default:
+        client.update_user(
+            name_id_or_prefix=client.active_user.id,
+            updated_default_project_id=project.id,
+        )
+        cli_utils.declare(
+            f"The default project has been set to {project.name}"
+        )
+
 
 @project.command("describe")
 @click.argument("project_name_or_id", type=str, required=False)

src/zenml/client.py

@@ -876,6 +876,7 @@ def update_user(
         old_password: Optional[str] = None,
         updated_is_admin: Optional[bool] = None,
         updated_metadata: Optional[Dict[str, Any]] = None,
+        updated_default_project_id: Optional[UUID] = None,
         active: Optional[bool] = None,
     ) -> UserResponse:
         """Update a user.
@@ -891,6 +892,7 @@ def update_user(
                 update.
             updated_is_admin: Whether the user should be an admin.
             updated_metadata: The new metadata for the user.
+            updated_default_project_id: The new default project ID for the user.
             active: Use to activate or deactivate the user.
 
         Returns:
@@ -928,6 +930,9 @@ def update_user(
         if updated_metadata is not None:
             user_update.user_metadata = updated_metadata
 
+        if updated_default_project_id is not None:
+            user_update.default_project_id = updated_default_project_id
+
         return self.zen_store.update_user(
             user_id=user.id, user_update=user_update
         )

src/zenml/config/global_config.py

@@ -123,6 +123,7 @@ class GlobalConfiguration(BaseModel, metaclass=GlobalConfigMetaClass):
     version: Optional[str] = None
     store: Optional[SerializeAsAny[StoreConfiguration]] = None
     active_stack_id: Optional[uuid.UUID] = None
+    active_project_id: Optional[uuid.UUID] = None
     active_project_name: Optional[str] = None
 
     _zen_store: Optional["BaseZenStore"] = None
@@ -393,14 +394,16 @@ def _sanitize_config(self) -> None:
         if ENV_ZENML_SERVER in os.environ:
             return
         active_project, active_stack = self.zen_store.validate_active_config(
-            self.active_project_name,
+            self.active_project_id or self.active_project_name,
             self.active_stack_id,
             config_name="global",
         )
         if active_project:
+            self.active_project_id = active_project.id
             self.active_project_name = active_project.name
             self._active_project = active_project
         else:
+            self.active_project_id = None
             self.active_project_name = None
             self._active_project = None
 

src/zenml/models/v2/core/user.py

@@ -203,6 +203,10 @@ class UserUpdate(UserBase, BaseUpdate):
         "accounts. Required when updating the password.",
         max_length=STR_FIELD_MAX_LENGTH,
     )
+    default_project_id: Optional[UUID] = Field(
+        default=None,
+        title="The default project ID for the user.",
+    )
 
     @model_validator(mode="after")
     def user_email_updates(self) -> "UserUpdate":
@@ -279,6 +283,10 @@ class UserResponseBody(BaseDatedResponseBody):
     is_admin: bool = Field(
         title="Whether the account is an administrator.",
     )
+    default_project_id: Optional[UUID] = Field(
+        default=None,
+        title="The default project ID for the user.",
+    )
 
 
 class UserResponseMetadata(BaseResponseMetadata):
@@ -422,6 +430,15 @@ def user_metadata(self) -> Dict[str, Any]:
         """
         return self.get_metadata().user_metadata
 
+    @property
+    def default_project_id(self) -> Optional[UUID]:
+        """The `default_project_id` property.
+
+        Returns:
+            the value of the property.
+        """
+        return self.get_body().default_project_id
+
     # Helper methods
     @classmethod
     def _get_crypt_context(cls) -> "CryptContext":