README.md

Scratch API wrapper with support for almost all site features. Created by TimMcCool.

This library can set cloud variables, follow Scratchers, post comments and do so much more! It has special features that make it easy to transmit data through cloud variables.

Links

• Documentation
• Extended documentation (WIP)
• Examples
• Change log

Report bugs by opening an issue on this repository. If you need help or guideance, leave a comment in the official forum topic. Projects made using scratchattach can be added to this Scratch studio.

Example usage

import scratchattach as scratch3

session = scratch3.login("username", "password")
conn = session.connect_cloud("project_id")

conn.set_var("variable", value)

More examples

Getting started

Installation:

Run the following command in your command prompt / shell:

pip install -U scratchattach

Logging in with username / password:

import scratchattach as scratch3

session = scratch3.login("username", "password")

login() returns a Session object that saves your login.

Logging in with a sessionId: You can get your session id from your browser's cookies. More information

import scratchattach as scratch3

session = scratch3.Session("sessionId", username="username") #The username field is case sensitive

Connect to the Scratch cloud:

conn = session.connect_cloud("project_id")

Get / Set a cloud var:

value = scratch3.get_var("project_id", "variable")
conn.set_var("variable", "value") #the variable name is specified without the cloud emoji

Follow a user / love a project:

user_to_follow = session.connect_user("username")
user_to_follow.follow()
project_to_love = session.connect_project("project_id")
project_to_love.love()

All scratchattach features are documented in the documentation.

Contributors

• Allmost all code by TimMcCool.
• See the GitHub repository for full list of contributors.
• Create a pull request to contribute code yourself.