scratchattach 2.1.15b0__tar.gz → 3.0.0b0__tar.gz

{scratchattach-2.1.15b0/scratchattach.egg-info → scratchattach-3.0.0b0}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: scratchattach
-Version: 2.1.15b0
+Version: 3.0.0b0
 Summary: A Scratch API Wrapper
 Author: TimMcCool
-Author-email: 
+License-Expression: MIT
 Project-URL: Source, https://github.com/timmccool/scratchattach
 Project-URL: Homepage, https://scratchattach.tim1de.net
 Keywords: scratch api,scratchattach,scratch api python,scratch python,scratch for python,scratch,scratch cloud,scratch cloud variables,scratch bot
@@ -13,6 +13,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: Unix
 Classifier: Operating System :: MacOS :: MacOS X
 Classifier: Operating System :: Microsoft :: Windows
+Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: websocket-client
@@ -21,18 +22,13 @@ Requires-Dist: bs4
 Requires-Dist: SimpleWebSocketServer
 Requires-Dist: typing-extensions
 Requires-Dist: browser_cookie3
+Requires-Dist: aiohttp
+Requires-Dist: rich
+Provides-Extra: cli
+Requires-Dist: rich-pixels; extra == "cli"
 Provides-Extra: lark
 Requires-Dist: lark; extra == "lark"
-Dynamic: author
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: keywords
 Dynamic: license-file
-Dynamic: project-url
-Dynamic: provides-extra
-Dynamic: requires-dist
-Dynamic: summary
 
 **scratchattach is a Scratch API wrapper with support for almost all site features.** Created by [TimMcCool](https://scratch.mit.edu/users/TimMcCool/).
 

scratchattach-3.0.0b0/pyproject.toml

@@ -0,0 +1,95 @@
+[build-system]
+requires = ["setuptools >= 77.0.3"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "scratchattach"
+version = "3.0.0b0"
+authors = [{ name = "TimMcCool" }]
+description = "A Scratch API Wrapper"
+requires-python = ">= 3.12"
+dependencies = [
+  "websocket-client",
+  "requests",
+  "bs4",
+  "SimpleWebSocketServer",
+  "typing-extensions",
+  "browser_cookie3",
+  "aiohttp",
+  "rich",
+]
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+keywords = [
+  "scratch api",
+  "scratchattach",
+  "scratch api python",
+  "scratch python",
+  "scratch for python",
+  "scratch",
+  "scratch cloud",
+  "scratch cloud variables",
+  "scratch bot",
+]
+classifiers = [
+  "Development Status :: 5 - Production/Stable",
+  "Intended Audience :: Developers",
+  "Programming Language :: Python :: 3",
+  "Operating System :: Unix",
+  "Operating System :: MacOS :: MacOS X",
+  "Operating System :: Microsoft :: Windows",
+]
+
+[project.urls]
+Source = "https://github.com/timmccool/scratchattach"
+Homepage = "https://scratchattach.tim1de.net"
+
+[project.scripts]
+scratch = "scratchattach.__main__:main"
+
+[project.optional-dependencies]
+cli = ["rich-pixels"]
+lark = ["lark"]
+
+[tool.ruff]
+line-length = 127
+exclude = [
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".git-rewrite",
+    ".hg",
+    ".ipynb_checkpoints",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".pyenv",
+    ".pytest_cache",
+    ".pytype",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    ".vscode",
+    "__pypackages__",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "node_modules",
+    "site-packages",
+    "venv",
+]
+[tool.ruff.lint]
+select = ["E9", "F63", "F7", "F82"] # , "C901"]  # uncomment to re-enable mccabe complexity - see https://github.com/TimMcCool/scratchattach/issues/566
+
+[tool.ruff.lint.mccabe]
+# max-complexity = 10
+
+[tool.setuptools.packages]
+find = { include = ["scratchattach"] }
+
+[dependency-groups]
+dev = ["cryptography>=46.0.3", "pytest>=9.0.2"]

{scratchattach-2.1.15b0 → scratchattach-3.0.0b0}/scratchattach/__init__.py

@@ -8,22 +8,30 @@ from .eventhandlers.cloud_storage import Database
 from .eventhandlers.combine import MultiEventHandler
 
 from .other.other_apis import *
-from .other.project_json_capabilities import ProjectBody, get_empty_project_pb, get_pb_from_dict, read_sb3_file, download_asset
+# from .other.project_json_capabilities import ProjectBody, get_empty_project_pb, get_pb_from_dict, read_sb3_file, download_asset
 from .utils.encoder import Encoding
 from .utils.enums import Languages, TTSVoices
-from .utils.exceptions import LoginDataWarning
+from .utils.exceptions import (
+    LoginDataWarning,
+    GetAuthenticationWarning,
+    StudioAuthenticationWarning,
+    ClassroomAuthenticationWarning,
+    ProjectAuthenticationWarning,
+    UserAuthenticationWarning)
 
-from .site.activity import Activity
+from .site.activity import Activity, ActivityTypes
 from .site.backpack_asset import BackpackAsset
-from .site.comment import Comment
+from .site.comment import Comment, CommentSource
 from .site.cloud_activity import CloudActivity
 from .site.forum import ForumPost, ForumTopic, get_topic, get_topic_list, youtube_link_to_scratch
 from .site.project import Project, get_project, search_projects, explore_projects
-from .site.session import Session, login, login_by_id, login_by_session_string, login_by_io, login_by_file, login_from_browser
+from .site.session import Session, login, login_by_id, login_by_session_string, login_by_io, login_by_file, \
+    login_from_browser
 from .site.studio import Studio, get_studio, search_studios, explore_studios
 from .site.classroom import Classroom, get_classroom
-from .site.user import User, get_user
+from .site.user import User, get_user, Rank
 from .site._base import BaseSiteComponent
 from .site.browser_cookies import Browser, ANY, FIREFOX, CHROME, CHROMIUM, VIVALDI, EDGE, EDGE_DEV, SAFARI
+from .site.placeholder import PlaceholderProject, get_placeholder_project, create_placeholder_project
 
 from . import editor

scratchattach-3.0.0b0/scratchattach/__main__.py

@@ -0,0 +1,93 @@
+"""
+Scratchattach CLI. Most source code is in the `cli` directory
+"""
+
+import argparse
+
+from scratchattach import cli
+from scratchattach.cli import db, cmd
+from scratchattach.cli.context import ctx, console
+
+import rich.traceback
+
+rich.traceback.install()
+
+
+# noinspection PyUnusedLocal
+def main():
+    parser = argparse.ArgumentParser(
+        prog="scratch",
+        description="Scratchattach CLI",
+        epilog=f"Running scratchattach CLI version {cli.VERSION}",
+    )
+
+    # Using walrus operator & ifs for artificial indentation
+    if commands := parser.add_subparsers(dest="command"):
+        commands.add_parser("profile", help="View your profile")
+        commands.add_parser("sessions", help="View session list")
+        if login := commands.add_parser("login", help="Login to Scratch"):
+            login.add_argument("--sessid", dest="sessid", nargs="?", default=False, const=True,
+                               help="Login by session ID")
+        if group := commands.add_parser("group", help="View current session group"):
+            if group_commands := group.add_subparsers(dest="group_command"):
+                group_commands.add_parser("list", help="List all session groups")
+                group_commands.add_parser("add", help="Add sessions to group")
+                group_commands.add_parser("remove", help="Remove sessions from a group")
+                group_commands.add_parser("delete", help="Delete current group")
+                if group_copy := group_commands.add_parser("copy", help="Copy current group with a new name"):
+                    group_copy.add_argument("group_name", help="New group name")
+                if group_rename := group_commands.add_parser("rename", help="Rename current group"):
+                    group_rename.add_argument("group_name", help="New group name")
+                if group_new := group_commands.add_parser("new", help="Create a new group"):
+                    group_new.add_argument("group_name")
+                if group_switch := group_commands.add_parser("switch", help="Change the current group"):
+                    group_switch.add_argument("group_name")
+
+    parser.add_argument("-U", "--username", dest="username", help="Name of user to look at")
+    parser.add_argument("-P", "--project", dest="project_id", help="ID of project to look at")
+    parser.add_argument("-S", "--studio", dest="studio_id", help="ID of studio to look at")
+    parser.add_argument("-L", "--session_name", dest="session_name",
+                        help="Name of (registered) session/login to look at")
+
+    args = parser.parse_args(namespace=cli.ArgSpace())
+    cli.ctx.args = args
+    cli.ctx.parser = parser
+
+    match args.command:
+        case "sessions":
+            cmd.sessions()
+        case "login":
+            cmd.login()
+        case "group":
+            cmd.group()
+        case "profile":
+            cmd.profile()
+        case None:
+            if args.username:
+                user = ctx.session.connect_user(args.username)
+                console.print(cli.try_get_img(user.icon, (30, 30)))
+                console.print(user)
+                return
+            if args.studio_id:
+                studio = ctx.session.connect_studio(args.studio_id)
+                console.print(cli.try_get_img(studio.thumbnail, (34, 20)))
+                console.print(studio)
+                return
+            if args.project_id:
+                project = ctx.session.connect_project(args.project_id)
+                console.print(cli.try_get_img(project.thumbnail, (30, 23)))
+                console.print(project)
+                return
+            if args.session_name:
+                if sess := ctx.db_get_sess(args.session_name):
+                    console.print(sess)
+                else:
+                    raise ValueError(f"No session logged in called {args.session_name!r} "
+                                     f"- try using `scratch sessions` to see available sessions")
+                return
+
+            parser.print_help()
+
+
+if __name__ == '__main__':
+    main()

{scratchattach-2.1.15b0 → scratchattach-3.0.0b0/scratchattach.egg-info}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: scratchattach
-Version: 2.1.15b0
+Version: 3.0.0b0
 Summary: A Scratch API Wrapper
 Author: TimMcCool
-Author-email: 
+License-Expression: MIT
 Project-URL: Source, https://github.com/timmccool/scratchattach
 Project-URL: Homepage, https://scratchattach.tim1de.net
 Keywords: scratch api,scratchattach,scratch api python,scratch python,scratch for python,scratch,scratch cloud,scratch cloud variables,scratch bot
@@ -13,6 +13,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: Unix
 Classifier: Operating System :: MacOS :: MacOS X
 Classifier: Operating System :: Microsoft :: Windows
+Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: websocket-client
@@ -21,18 +22,13 @@ Requires-Dist: bs4
 Requires-Dist: SimpleWebSocketServer
 Requires-Dist: typing-extensions
 Requires-Dist: browser_cookie3
+Requires-Dist: aiohttp
+Requires-Dist: rich
+Provides-Extra: cli
+Requires-Dist: rich-pixels; extra == "cli"
 Provides-Extra: lark
 Requires-Dist: lark; extra == "lark"
-Dynamic: author
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: keywords
 Dynamic: license-file
-Dynamic: project-url
-Dynamic: provides-extra
-Dynamic: requires-dist
-Dynamic: summary
 
 **scratchattach is a Scratch API wrapper with support for almost all site features.** Created by [TimMcCool](https://scratch.mit.edu/users/TimMcCool/).
 

scratchattach-3.0.0b0/scratchattach.egg-info/SOURCES.txt

@@ -0,0 +1,25 @@
+LICENSE
+README.md
+pyproject.toml
+scratchattach/__init__.py
+scratchattach/__main__.py
+scratchattach.egg-info/PKG-INFO
+scratchattach.egg-info/SOURCES.txt
+scratchattach.egg-info/dependency_links.txt
+scratchattach.egg-info/entry_points.txt
+scratchattach.egg-info/requires.txt
+scratchattach.egg-info/top_level.txt
+tests/test_activity.py
+tests/test_auth.py
+tests/test_comment.py
+tests/test_editor_integration.py
+tests/test_editor_obfuscation.py
+tests/test_editor_project.py
+tests/test_import.py
+tests/test_memberships.py
+tests/test_other_apis.py
+tests/test_project.py
+tests/test_search.py
+tests/test_studio.py
+tests/test_teacher_activity.py
+tests/test_user.py

scratchattach-3.0.0b0/scratchattach.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+scratch = scratchattach.__main__:main

{scratchattach-2.1.15b0 → scratchattach-3.0.0b0}/scratchattach.egg-info/requires.txt

@@ -4,6 +4,11 @@ bs4
 SimpleWebSocketServer
 typing-extensions
 browser_cookie3
+aiohttp
+rich
+
+[cli]
+rich-pixels
 
 [lark]
 lark

{scratchattach-2.1.15b0 → scratchattach-3.0.0b0}/tests/test_activity.py

@@ -1,23 +1,22 @@
-import sys
 from datetime import datetime, timedelta, timezone
 import warnings
-
+import scratchattach as sa
+from scratchattach.utils import exceptions
+import util
 
 
 def test_activity():
-    sys.path.insert(0, ".")
-    import scratchattach as sa
-    from scratchattach.utils import exceptions
-    import util
     if not util.credentials_available():
-        warnings.warn("Skipped test_activity because there were no credentials available.")
+        warnings.warn(
+            "Skipped test_activity because there were no credentials available."
+        )
         return
     sess = util.session()
 
     # we cannot do assertions, but we can probe for any errors.
     messages = sess.messages()
     for msg in messages:
-        print(msg, end=' ')
+        print(msg, end=" ")
 
         try:
             target = msg.target()

{scratchattach-2.1.15b0 → scratchattach-3.0.0b0}/tests/test_auth.py

@@ -1,10 +1,10 @@
 import sys
 import os
 import warnings
+import util
+
 
 def test_auth():
-    sys.path.insert(0, ".")
-    import util
     if not util.credentials_available():
         warnings.warn("Skipped test_auth because there were no credentials available.")
         return

{scratchattach-2.1.15b0 → scratchattach-3.0.0b0}/tests/test_comment.py

@@ -1,13 +1,14 @@
-import sys
 from datetime import datetime, timedelta, timezone
 import warnings
+import scratchattach as sa
+import util
+
 
 def test_comment():
-    sys.path.insert(0, ".")
-    import scratchattach as sa
-    import util
     if not util.credentials_available():
-        warnings.warn("Skipped test_comment because there were no credentials available.")
+        warnings.warn(
+            "Skipped test_comment because there were no credentials available."
+        )
         return
     sess = util.session()
 
@@ -18,37 +19,39 @@ def test_comment():
     comment = user.comments(limit=1)[0]
 
     assert comment.id == "387076703"
-    #assert comment.source == sa.CommentSource.USER_PROFILE
+    assert comment.source == sa.CommentSource.USER_PROFILE
     assert comment.source_id == "ScratchAttachV2"
     assert comment.parent_id is None
     assert comment.content == "Sample comment"
-    assert datetime.fromisoformat(comment.datetime_created) - datetime(2025, 8, 25, tzinfo=timezone.utc) < timedelta(days=1)
+    assert datetime.fromisoformat(comment.datetime_created) - datetime(
+        2025, 8, 25, tzinfo=timezone.utc
+    ) < timedelta(days=1)
     assert comment.reply_count == 0
     assert comment.text == "Sample comment"
 
     comment = proj.comments(limit=1)[0]
 
     assert comment.id == 494890468
-    #assert comment.source == sa.CommentSource.PROJECT
+    assert comment.source == sa.CommentSource.PROJECT
     assert comment.source_id == 1108326850
     assert comment.parent_id is None
-    assert comment.content == ("&lt;&amp;;&apos;!\n"
-                               "newline\n"
-                               "testing escaping")
-    assert datetime.fromisoformat(comment.datetime_created) - datetime(2025, 9, 20, tzinfo=timezone.utc) < timedelta(days=1)
+    assert comment.content == ("&lt;&amp;;&apos;!\n" "newline\n" "testing escaping")
+    assert datetime.fromisoformat(comment.datetime_created) - datetime(
+        2025, 9, 20, tzinfo=timezone.utc
+    ) < timedelta(days=1)
     assert comment.reply_count == 0
-    assert comment.text == ("<&;'!\n"
-                            "newline\n"
-                            "testing escaping")
+    assert comment.text == ("<&;'!\n" "newline\n" "testing escaping")
 
     comment = studio.comments(limit=1)[0]
 
     assert comment.id == 302129887
-    #assert comment.source == sa.CommentSource.STUDIO
+    assert comment.source == sa.CommentSource.STUDIO
     assert comment.source_id == 50809872
     assert comment.parent_id is None
     assert comment.content == "Sample"
-    assert datetime.fromisoformat(comment.datetime_created) - datetime(2025, 8, 26, tzinfo=timezone.utc) < timedelta(days=1)
+    assert datetime.fromisoformat(comment.datetime_created) - datetime(
+        2025, 8, 26, tzinfo=timezone.utc
+    ) < timedelta(days=1)
     assert comment.reply_count == 1
     assert not comment.written_by_scratchteam
     assert comment.text == "Sample"
@@ -56,15 +59,18 @@ def test_comment():
     comment = comment.replies(limit=1)[0]
 
     assert comment.id == 302129910
-    #assert comment.source == sa.CommentSource.STUDIO
+    assert comment.source == sa.CommentSource.STUDIO
     assert comment.source_id == 50809872
     assert comment.parent_id == 302129887
     assert comment.commentee_id == 58743127
     assert comment.content == "text"
-    assert datetime.fromisoformat(comment.datetime_created) - datetime(2025, 8, 26, tzinfo=timezone.utc) < timedelta(days=1)
+    assert datetime.fromisoformat(comment.datetime_created) - datetime(
+        2025, 8, 26, tzinfo=timezone.utc
+    ) < timedelta(days=1)
     assert comment.reply_count == 0
     assert not comment.written_by_scratchteam
     assert comment.text == "text"
 
+
 if __name__ == "__main__":
     test_comment()

{scratchattach-2.1.15b0 → scratchattach-3.0.0b0}/tests/test_editor_integration.py

@@ -1,22 +1,22 @@
 import pprint
-import sys
 import warnings
+import util
+import scratchattach as sa
+
 
 def test_project():
-    sys.path.insert(0, ".")
-    import scratchattach as sa
-    import util
     if not util.credentials_available():
-        warnings.warn("Skipped test_project because there were no credentials available.")
+        warnings.warn(
+            "Skipped test_project because there were no credentials available."
+        )
         return
     sess = util.session()
 
-
     project = sess.connect_project(104)
     body = project.body()
     body.to_json()  # do nothing with the data, just make sure it works.
 
 
+if __name__ == "__main__":
+    test_project()
 
-if __name__ == '__main__':
-    test_project()

{scratchattach-2.1.15b0 → scratchattach-3.0.0b0}/tests/test_editor_obfuscation.py

@@ -1,12 +1,9 @@
 import pprint
-import sys
 from pathlib import Path
+import scratchattach as sa
 
 
 def test_project():
-    return
-    sys.path.insert(0, ".")
-    import scratchattach as sa
 
     path = Path(__file__).parent.parent / "intro for kelmare (yoda tour) (p2).sb3"
 
@@ -24,5 +21,5 @@ def test_project():
     body.export("obfuscated.sb3")
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     test_project()

scratchattach-3.0.0b0/tests/test_editor_project.py

@@ -0,0 +1,6 @@
+import scratchattach as sa
+
+
+def test_editor_project():
+    proj = sa.get_project(104)
+    body = proj.body()

scratchattach-3.0.0b0/tests/test_import.py

@@ -0,0 +1,5 @@
+import scratchattach as sa
+
+
+def test_import():
+    pass

scratchattach-3.0.0b0/tests/test_memberships.py

@@ -0,0 +1,36 @@
+import scratchattach as sa
+import warnings
+
+warnings.filterwarnings("ignore", category=sa.UserAuthenticationWarning)
+
+
+def test_memberships():
+    # unfortunately we don't have amazingly robust test-cases here.
+    u1 = sa.get_user("-KittyMax-")
+    assert u1.is_member
+    assert u1.has_ears
+    assert u1.has_badge()
+
+    u2 = sa.get_user("ceebee")
+    assert u2.is_member
+    assert u2.has_ears
+    assert u2.has_badge()
+
+    u3 = sa.get_user("scratchattachv2")
+    assert not u3.is_member
+    assert not u3.has_ears
+    assert not u3.has_badge()
+
+    u4 = sa.get_user("peekir")
+    assert u4.is_member
+    assert u4.has_ears
+    assert u4.has_badge()
+
+    u5 = sa.get_user("StardreamT2")
+    assert u5.is_member
+    assert u5.has_ears
+    assert not u5.has_badge()
+
+
+if __name__ == "__main__":
+    test_memberships()

{scratchattach-2.1.15b0 → scratchattach-3.0.0b0}/tests/test_other_apis.py

@@ -1,17 +1,14 @@
 import pprint
-import sys
 from datetime import datetime, timedelta, timezone
 import warnings
+import scratchattach as sa
+from scratchattach.utils import exceptions
+import util
 
 
 def test_other_apis():
-    sys.path.insert(0, ".")
-    import scratchattach as sa
-    from scratchattach.utils import exceptions
-    import util
-
-    #assert sa.check_email("example@example.com")
-    #assert not sa.check_email("bad_email")
+    assert sa.check_email("example@example.com")
+    assert not sa.check_email("bad_email")
 
     news = sa.get_news()
     found_wiki_wednesday = False

{scratchattach-2.1.15b0 → scratchattach-3.0.0b0}/tests/test_project.py

@@ -1,20 +1,19 @@
-import pprint
-import sys
 import warnings
+from util import session, credentials_available
+import scratchattach as sa
+
 
 def test_project():
-    sys.path.insert(0, ".")
-    import scratchattach as sa
-    from util import session, credentials_available
     if not credentials_available():
-        warnings.warn("Skipped test_project because there were no credentials available.")
+        warnings.warn(
+            "Skipped test_project because there were no credentials available."
+        )
         return
     sess = session()
 
-
     project = sess.connect_project(104)
-    #tree = project.remix_tree_pretty()
-    #assert len(tree) > 1000 # there is a lot of chars. Just assert that sth is generated
+    # tree = project.remix_tree_pretty()
+    # assert len(tree) > 1000 # there is a lot of chars. Just assert that sth is generated
 
     project = sess.connect_project(1209355136)
 
@@ -59,14 +58,15 @@ def test_project():
     assert remix.author_name == "ScratchAttachV2"
     assert remix.embed_url == "https://scratch.mit.edu/projects/1209582809/embed"
 
-    #assert sess.connect_project(414601586).moderation_status() == "notsafe"
-    #assert sess.connect_project(1207314193).moderation_status() == "safe"
-    #assert sess.connect_project(
-    #    1233).moderation_status() == "notreviewed"  # if this becomes reviewed, please update this
+    # assert sess.connect_project(414601586).moderation_status() == "notsafe"
+    # assert sess.connect_project(1207314193).moderation_status() == "safe"
+    # assert sess.connect_project(
+    # 1233).moderation_status() == "notreviewed"  # if this becomes reviewed, please update this
     # ^^ also this project is an infinite remix loop!
 
     assert sa.explore_projects()
     assert sa.search_projects(query="scratchattach")
 
-if __name__ == '__main__':
-    test_project()
+
+if __name__ == "__main__":
+    test_project()