feat: set featured project data

closes #597

also makes the virtualenv for tests/ refer to scratchattach in an editable manner. I am not satisfied with the setup though. there may be a more idiomatic way to do it with workspaces but I do not know how

Author: faretek1

pyproject.toml

@@ -94,6 +94,9 @@ select = [
 [tool.ruff.lint.mccabe]
 max-complexity = 10
 
+[tool.uv]
+config-settings = { editable_mode = "compat" }
+
 [tool.setuptools.packages.find]
 where = ["."]
 include = ["scratchattach*"]

scratchattach/site/session.py

@@ -15,7 +15,7 @@
 import zlib
 
 from dataclasses import dataclass, field
-from typing import Optional, TypeVar, TYPE_CHECKING, overload, Any, Union, cast
+from typing import Literal, Optional, TypeVar, TYPE_CHECKING, overload, Any, Union, cast
 from contextlib import contextmanager
 from threading import local
 
@@ -318,6 +318,36 @@ def logout(self):
         """
         requests.post("https://scratch.mit.edu/accounts/logout/", headers=self._headers, cookies=self._cookies)
 
+    def set_featured_data(self, project_id: Optional[int] | Literal[""], project_label: Optional[int] | Literal[""] = None):
+        """
+        Sends a request to change your featured project area.
+
+        Positional arguments:
+            project_id: None -> don't change; empty string -> set to latest project (this is what most accounts have); int -> set the featured project to the one with the corresponding ID. If you do not own that project, an error is raised.
+            project_lavel: None -> don't change; empty string -> "Featured project"; 0 -> "Featured Tutorial"; 1 -> "Work in progress"; 2 -> "Remix this!"; 3 -> "My favorite things"; 4 -> "Why I scratch"
+
+        Returns:
+            list<scratch.activity.Activity>: List that contains all messages as Activity objects.
+
+        """
+        # TODO: consider using an enum here for project label and match that with user.get_featured_data
+        payload: dict[str, int | str] = {}
+        if project_label is not None:
+            payload["featured_project_label"] = str(project_label)
+        if project_id is not None:
+            payload["featured_project"] = project_id
+
+        data = requests.put(
+            f"https://scratch.mit.edu/site-api/users/all/{self.username}/",
+            json=payload,
+            headers=self._headers,
+            cookies=self._cookies,
+        ).json()
+        if errors := data.get("errors"):
+            raise Exception(f"Backend responded with error: {errors[0] if len(errors) == 1 else errors}")
+
+        return data
+
     @property
     def ocular_headers(self) -> dict[str, str]:
         self._assert_ocular_auth()

tests/pyproject.toml

@@ -17,5 +17,8 @@ dependencies = [
 requires = ["uv_build>=0.10.10,<0.11.0"]
 build-backend = "uv_build"
 
+[tool.uv]
+config-settings = { editable_mode = "compat" }
+
 [tool.uv.sources]
-scratchattach = { path = "../" }
+scratchattach = { path = "../", editable = true }