feat: project page

Author: faretek1

scratch_cli/__main__.py

@@ -49,7 +49,10 @@ def main():
             config.add_subparsers(dest="config_command").add_parser("edit", help="Edit your scli config")
 
     parser.add_argument("-U", "--user", dest="username",
-                        help="Get user by username")
+                        help="Get user by name")
+
+    parser.add_argument("-P", "--project", type=int, dest="project_id",
+                        help="Get project by id")
 
     args = parser.parse_args(namespace=_Args())
 
@@ -83,6 +86,9 @@ def do_cmd(parser: argparse.ArgumentParser, args: _Args) -> None:
             if args.username:
                 cmd.find(user=args.username)
                 return
+            if args.project_id:
+                cmd.find(project=args.project_id)
+                return
 
             parser.print_help()
 

scratch_cli/_args.py

@@ -4,6 +4,7 @@
 class Args(argparse.Namespace):
     command: Literal['login', 'group', 'groups', 'ungroup', 'profile', 'find', 'config', None]
     username: Optional[str]
+    project_id: Optional[int]
 
     # find
     offset: int

scratch_cli/assets/project_page.md

@@ -0,0 +1,20 @@
+# {title} by {author}
+
+## #{id} (https://scratch.mit.edu/projects/{id}/)
+
+### Instructions
+
+{instructions}
+
+### Notes and credits
+
+{notes}
+
+|               |               |    |                   |                       |
+|---------------|---------------|----|-------------------|-----------------------|
+| 👁 Views      | {views}       | \| | Commenting status | `{commenting_status}` |
+| ♥ Loves       | {loves}       | \| | Last modified     | {last_modified}       |
+| ★ Favorites   | {faves}       | \| | Created           | {created}             |
+| ꩜ Remix count | {remix_count} | \| | (Remix) Parent ID | {remix_parent}        |
+
+

scratch_cli/cmd/find.py

@@ -35,6 +35,7 @@ def find(*,
          offset: int = 0,
          limit: int = 10,
          user: Optional[str] = None,
+         project: Optional[int] = None,
          mode: Optional[str] = None, ):
     if user:
         user: sa.User = context.session.connect_user(user)
@@ -70,6 +71,15 @@ def find(*,
 
         return
 
+    if project:
+        project: sa.Project = context.session.connect_project(project)
+
+        match mode:
+            case "page" | None:
+                rfmt.print_md(safmt.project_page(project))
+
+        return
+
     # assume we are in session mode
     find_in_session(
         offset=offset,

scratch_cli/safmt.py

@@ -53,6 +53,25 @@ def _handle_configurable_markdownable(raw: str, content: Optional[str], replace:
             return f'{raw}{splitter}{content}'
     return raw
 
+def project_page(self: sa.Project):
+    # todo: allow for project-specific scli config
+
+    return rfmt.md_fp(
+        "project_page.md",
+        title=rfmt.escape(self.title),
+        author=self.author_name if hasattr(self, "author_name") else None,
+        id=self.id,
+        instructions=rfmt.quote(_handle_configurable_markdownable(rfmt.escape(self.instructions), "", False)),
+        notes=rfmt.quote(_handle_configurable_markdownable(rfmt.escape(self.notes), "", False)),
+        views=self.views,
+        loves=self.loves,
+        faves=self.favorites,
+        remix_count=self.remix_count,
+        created=self.created,
+        last_modified=self.last_modified,
+        commenting_status="on" if self.comments_allowed else "off",
+        remix_parent=self.remix_parent
+    )
 
 def user_profile(self: sa.User):
     config = scli_config(self)