Examples

Example scripts

Set a cloud var with scratchattach:

# Example: Set Cloud Variable

import scratchattach as scratch3 # Import the scratchattach module

session = scratch3.login("username", "password") # Login with Scratch login information (replace with your username and password)
conn = session.connect_cloud("project_id") # Replace project_id with your project ID

conn.set_var("variable", value) # Set a cloud variable to a certain value (int, float or string consisting of numbers)

Cloud event handler:

import scratchattach as scratch3 # Import the scratchattach module
events = scratch3.CloudEvents("project_id") # Replace project_id with your project id. No login required.

# Get event listener.
@events.event
def on_set(event): #Called when a cloud var is set
    # Things inside here only happen if a cloud variable is set. 
    print(f"{event.user} set the variable {event.var} to the value {event.value} at {event.timestamp}")

events.start() # Start listening for events.

Comment on a project:

import scratchattach as scratch3 # Import the scratchattach module

session = scratch3.login("username", "password") # Log in with Scratch login information (replace with your username and password)
project = session.connect_project("project_id") # Replace project_id with your project id

project.post_comment("Hi guys!") # Post a comment on the project.

Automatically update your profile with your follower count:

import scratchattach as scratch3 # Import the scratchattach module
import time # Import time module.

session = scratch3.login("username", "password") # Log in with Scratch login information (replace with your username and password).
user = session.get_linked_user() # Get the your Scratch profile as User object.

while True:
    follower_count = user.follower_count() # Get follower count
    user.set_bio(f"My follower count: {follower_count}") # Updates "What I'm working on" section on your profile.
    time.sleep(60) # Waits 60 seconds before updating the section again.