# ScratchConnect v4.5
Python Library to connect Scratch API and much more.
This library can show the statistics of Users, Projects, Studios, Forums and also connect and set cloud variables of a
project!
**This library needs a Scratch account. Visit the Scratch Website: [https://scratch.mit.edu/](https://scratch.mit.edu/)
You also need to have the Python programming language installed on your computer.**
**You need basic knowledge of Python. Using this library without the knowledge can be risky.**
[](https://pypi.org/project/scratchconnect/)
### Installation
To install this library, just type ```pip install scratchconnect``` in the terminal (Command Prompt)
**OR**
Run this Python program
```python
import os
os.system('pip install scratchconnect')
```
**If you still have troubles while installing then go
to [this link](https://packaging.python.org/tutorials/installing-packages/)**
### Documentation
Documentation is taking a bit longer to make. It will be ready soon...
### Data Credits:
These are the people who made the APIs so that this library can take data:
* [Scratch API](https://github.com/LLK/scratch-rest-api) by the Scratch Team
* [Scratch DB](https://scratchdb.lefty.one/) by [@DatOneLefty](https://scratch.mit.edu/users/DatOneLefty/) on Scratch
* [Scratch Comments API](https://github.com/Sid72020123/Scratch-Comments-API)
by [@Sid72020123](https://scratch.mit.edu/users/Sid72020123/) on Scratch
* [Simple Forum API](https://github.com/Sid72020123/Scratch-Forum)
by [@Sid72020123](https://scratch.mit.edu/users/Sid72020123/) on Scratch
* [Ocular API](https://ocular.jeffalo.net/) by [@Jeffalo](https://scratch.mit.edu/users/Jeffalo/) on Scratch
* [Aviate API](https://aviateapp.eu.org/) by [@NFlex23](https://scratch.mit.edu/users/NFlex23/) on Scratch
```
I thank all these people.
- Owner (Sid72020123)
```
### Creating a Simple Connection:
Following is a simple program to make a simple connection:
**Note: Don't put the username and password as it is when you host or share the code with others. While hosting, you can
use environment variables and while sharing, you can remove the username and password values. This will help in keeping
the password and other important things secured.**
```python
import scratchconnect
user = scratchconnect.ScratchConnect("Username", "Password")
```
It will give an error if the `username` or `password` is invalid.
### More Uses:
##### Note: Some of the functions below can be only used by the logged in Scratcher. To get the stats of other users see the User Connection Documentation
```python
import scratchconnect
user = scratchconnect.ScratchConnect("Username", "Password")
user.id() # Returns the ID of the user
user.thumbnail_url() # Returns the thumbnail URL of a user
user.messages_count() # Returns the messages count of the user
user.messages(all=False, limit=20, offset=0, filter="all") # Returns the messages
user.clear_messages() # Clear your messages
user.my_stuff_projects(order="all", page=1, sort_by="") # Get/Sort mystuff projects
user.work() # Returns the 'What I am working on' of a Scratch profile
user.bio() # Returns the 'About me' of a Scratch profile
user.status() # Returns the status(Scratcher or New Scratcher) of a Scratch profile
user.joined_date() # Returns the joined date of a Scratch profile
user.country() # Returns the country of a Scratch profile
user.featured_data() # Returns the featured project data of the Scratch profile
user.projects() # Returns the list of shared projects of a user
user.followers_count() # Returns the follower count of a user
user.following_count() # Returns the following count of a user
user.total_views() # Returns the total views count of all the shared projects of a user
user.total_loves_count() # Returns the total loves count of all the shared projects of a user
user.total_favourites_count() # Returns the total favourites count of all the shared projects of a user
user.following() # Returns the list of the user following
user.followers() # Returns the list of the user followers
user.favourites() # Returns the list of the user favourites
user.toggle_commenting() # Toggle the commenting of the profile
user.follow_user(username="Sid72020123") # Follow a user
user.unfollow_user(username="Sid72020123") # UnFollow a user
user.set_bio(content="Hi!") # Set the bio or 'About Me' of the profile
user.set_work(content="Hi!") # Set the status or 'What I am Working On' of the profile
user.all_data() # Returns all the data of the user
user.site_health() # Returns the health of the Scratch Website.
user.site_news() # Returns the news of the Scratch Website.
user.site_front_page_projects() # Returns the front page projects of the Scratch Website.
user.explore_projects(mode="trending", query="*") # Explore the projects
user.explore_studios(mode="trending", query="*") # Explore the studios
user.search_projects(mode="trending", search="*") # Search the projects
user.search_studios(mode="trending", search="*") # Search the studios
user.set_featured_project(project_id="1", label='featured_project') # Set the 'Featured Project' of a Scratch Profile
user.user_follower_history() # Return the follower history of the user
user.comments(limit=5, page=1) # Get comments of the profile of the user
user.ocular_data() # Returns the ocular data of the user
user.aviate_data(code=False) # Returns the Aviate Status of the user
user.search_forum(q="Hi!", order="relevance", page=0) # Search the forum
##########################################################################
# IMPORTANT NOTE: To always get the updated data use the update_data() function
##########################################################################
user.update_data() # Update the data
```
### Connect a Scratch User:
To connect a Scratch User use the `connect_user()` function. Use the following program to connect a Scratch User:
```python
import scratchconnect
login = scratchconnect.ScratchConnect("Username", "Password")
user = login.connect_user(username="Sid72020123")
user.id() # Returns the ID of the user
user.thumbnail_url() # Returns the thumbnail URL of a user
user.messages_count() # Returns the messages count of the user
user.work() # Returns the 'What I am working on' of a Scratch profile
user.bio() # Returns the 'About me' of a Scratch profile
user.status() # Returns the status(Scratcher or New Scratcher) of a Scratch profile
user.joined_date() # Returns the joined date of a Scratch profile
user.country() # Returns the country of a Scratch profile
user.featured_data() # Returns the featured project data of the Scratch profile
user.projects() # Returns the list of shared projects of a user
user.followers_count() # Returns the follower count of a user
user.following_count() # Returns the following count of a user
user.total_views_count() # Returns the total views count of all the shared projects of a user
user.total_loves_count() # Returns the total loves count of all the shared projects of a user
user.total_favourites_count() # Returns the total favourites count of all the shared projects of a user
user.following() # Returns the list of the user following
user.followers() # Returns the list of the user followers
user.favourites() # Returns the list of the user favourites
user.user_follower_history() # Return the follower history of the user
user.post_comment(content="Hi!") # Post a comment on the user's profile
user.report(field="") # Report a user
user.reply_comment(content="Hi!", comment_id=1) # Reply a comment
user.all_data() # Returns all the data of the user
user.comments(limit=5, page=1) # Get comments of the profile of the user
user.ocular_data() # Returns the ocular data of the user
user.aviate_data(code=False) # Returns the Aviate Status of the user
##########################################################################
# IMPORTANT NOTE: To always get the updated data use the update_data() function
##########################################################################
user.update_data() # Update the data
```
### Connect a Scratch Studio:
To connect a Scratch Studio use the `connect_studio()` function. Use the following program to connect a Scratch Studio:
```python
import scratchconnect
user = scratchconnect.ScratchConnect("Username", "Password")
studio = user.connect_studio(studio_id=1)
studio.id() # Returns the studio ID
studio.title() # Returns the studio title
studio.host_id() # Returns the studio owner/host ID
studio.description() # Returns the studio description
studio.visibility() # Returns the studio visibility
studio.is_public() # Returns whether a studio is public
studio.is_open_to_all() # Returns whether a studio is open to all
studio.are_comments_allowed() # Returns whether a studio has comments allowed
studio.history() # Returns the history of the studio
studio.stats() # Returns the stats of the studio
studio.thumbnail_url() # Returns the thumbnail URL of the studio
studio.add_project(project_id=1) # Add a project to a studio
studio.remove_project(project_id=1) # Remove a project from a studio
studio.open_to_public() # Open the studio to public
studio.close_to_public() # Close the studio to public
studio.follow_studio() # Follow the studio
studio.unfollow_studio() # UnFollow the studio
studio.toggle_commenting() # Toggle the commenting of the studio
studio.post_comment(content="Hi!") # Post comment in the studio
studio.reply_comment(content="Hi!", comment_id=1) # Reply a comment in a studio
studio.delete_comment() # Delete comment in the studio
studio.report_comment(comment_id=1) # Report comment in the studio
studio.invite_curator(username="Sid72020123") # Invite a user to the studio
studio.accept_curator() # Accept the curator invitation in a studio
studio.promote_curator(username="Sid72020123") # Promote a user in the studio
studio.set_description(content="Hi!") # Set the description of a Studio
studio.set_title(content="Hi!") # Set the title of a Studio
studio.projects(all=False, limit=40, offset=0) # Get the projects of the studio
studio.comments(all=False, limit=40, offset=0) # Get the comments of the studio
studio.curators(all=False, limit=40, offset=0) # Get the curators of the studio
studio.managers(all=False, limit=40, offset=0) # Get the managers of the studio
studio.activity(all=False, limit=40, offset=0) # Get the activity of the studio
studio.all_data() # Returns all the data of a Scratch Studio
##########################################################################
# IMPORTANT NOTE: To always get the updated data use the update_data() function
##########################################################################
studio.update_data() # Update the data
```
### Connect a Scratch Project:
To connect a Scratch Project use the `connect_project()` function. Use the following program to connect a Scratch
Project:
```python
import scratchconnect
user = scratchconnect.ScratchConnect("Username", "Password")
project = user.connect_project(project_id=1) # Connect a project.
project.author() # Returns the author of the project
project.title() # Returns the title of the project
project.notes() # Returns the notes(Notes or Credits) of the project
project.instruction() # Returns the instructions of the project
project.are_comments_allowed() # Returns whether the comments are allowed in a project
project.stats() # Returns the stats of a project
project.history() # Returns the history of a project
project.remix_data() # Returns the remix data of a project
project.visibility() # Returns whether the project is visible
project.is_public() # Returns whether the project is public
project.is_published() # Returns whether the project is published
project.thumbnail_url() # Returns the thumbnail url of a project
project.assets_info() # Returns the Assets info of a project
project.scripts() # Returns the scripts of a project
project.love() # Love a project
project.unlove() # UnLove a project
project.favourite() # Favourite a project
project.unfavourite() # UnFavourite a project
project.comments(all=False, limit=40, offset=0, comment_id=None) # Returns the list of comments of a project
project.remixes(all=False, limit=20, offset=0) # Returns the list of remixes of a project
project.post_comment(content="Hi!") # Post a comment
project.reply_comment(content="Hi!", comment_id=1) # Reply a comment
project.toggle_commenting() # Toggle the commenting of a project
project.turn_on_commenting() # Turn On the commenting of a project
project.turn_off_commenting() # Turn Off the commenting of a project
project.report(category="", reason="") # Report a project
project.unshare() # Unshare a project
project.view() # Just view a project
project.set_thumbnail(file="") # Set the thumbnail of a project
project.delete_comment(comment_id=1) # Delete a comment
project.report_comment(comment_id=1) # Report a comment
project.reply_comment(comment_id=1, content="Hi!") # Reply a comment
project.set_title() # Set the title of the project
project.set_description() # Set the description of the project
project.set_instruction() # Set the instruction of the project
project.all_data() # Returns all the data of a Scratch Project
##########################################################################
# IMPORTANT NOTE: To always get the updated data use the update_data() function
##########################################################################
project.update_data() # Update the data
```
#### Want to access and set the cloud variables of an unshared project?
Use the Following Code:
**Note: By accessing an unshared project, some data may not be accessible to this library so some data might not appear.
You can get the scripts and connect cloud variables of an unshared project.**
```python
import scratchconnect
user = scratchconnect.ScratchConnect("Username", "Password")
project = user.connect_project(project_id=1,
access_unshared=True) # Use the 'access_unshared' parameter to access the unshared project.
```
### Connect Cloud Variables of a Scratch Project:
To connect the cloud variables of a Scratch Project use the `connect_cloud_variables()` function. Use the following
program to connect the cloud variables of a Scratch Project:
```python
import scratchconnect
user = scratchconnect.ScratchConnect("Username", "Password")
project = user.connect_project(project_id=1)
variables = project.connect_cloud_variables()
variables.get_variable_data(limit=100, offset=0) # Returns the cloud variable data
variables.get_cloud_variable_value(variable_name="Name", limit=100) # Returns the cloud variable value
# Program to set cloud variables:
set = variables.set_cloud_variable(variable_name="Name", value=123) # Set a Cloud Variable
if set:
print("Cloud Variable Updated!")
```
### Connect Cloud Variables of Turbowarp:
To connect the cloud variables of a Turbowarp Project use the `connect_turbowarp_cloud()` function. Use the following
program to connect the cloud variables of a Turbowarp Project:
**Note: Turbowarp doesn't provide any features to get the data, etc. so you can't do some actions with Turbowarp as in
Scratch**
**Note: Use the ```acccess_unshared=True``` parameter of the ```connect_project()``` function to connect the Turbowarp
Project even if it is unshared on Scratch!**
```python
import scratchconnect
user = scratchconnect.ScratchConnect("Username", "Password")
project = user.connect_project(project_id=1) # Connect a Project
tw_cloud = project.connect_turbowarp_cloud(
username="Username") # Connect the Turbowarp cloud with an optional parameter to change the username!
tw_cloud.set_cloud_variable(variable_name="Name", value=0) # Set a Turbowarp variable
tw_cloud.get_variable_data() # Get the data of the previous value of the variable. NOT Current
```
### Error with Turbowarp Cloud?
Sometimes there mat be error with the Turbowarp Cloud. Some Basic Errors are:
**1. I can't change the Cloud Variable Value**
If you can't change the Turbowarp Cloud Variable value using scratchconnect then first check if your code is correct. If
the problem still exists try with this
URL: ```https://turbowarp.org/<project ID>?cloud_host=wss://clouddata.turbowarp.org```. Replace the ```project ID```
with your project ID.
### Encoding/Decoding Cloud Variables:
#### In Scratch
ScratchConnect v2.0+ has some good features to encode/decode a cloud variable! See some examples below:
**ScratchConnect has a case-sensitive encoding/decoding system. For example both 'A' and 'a' are encoded/decoded
differently!**
Go to [this link](https://scratch.mit.edu/projects/578255313/) for the Scratch version of Encoder/Decoder
##### Encoding/Decoding a string:
```python
import scratchconnect
login = scratchconnect.ScratchConnect("Username", "Password")
project = login.connect_project(1) # Connect the project
variables = project.connect_cloud_variables() # Connect the project's cloud variables
encoded_string = variables.encode("Hi! This is a text!") # Encode a string
variables.set_cloud_variable(variable_name='Name', value=encoded_string)
variable_value = variables.get_cloud_variable_value(variable_name='Name')[0] # Get the variable value
decoded_string = variables.decode(variable_value) # Decode a string
print("Encoded: ", encoded_string) # Print the results to check
print("Decoded: ", decoded_string) # Print the results to check
```
##### Encoding/Decoding a list:
```python
import scratchconnect
login = scratchconnect.ScratchConnect("Username", "Password")
project = login.connect_project(1) # Connect the project
variables = project.connect_cloud_variables() # Connect the project's cloud variables
data = ['A', 'B', 'C']
encoded_string = variables.encode_list(data) # Encode a list
variables.set_cloud_variable(variable_name='Name', value=encoded_string)
variable_value = variables.get_cloud_variable_value(variable_name='Name')[0] # Get the variable value
decoded_string = variables.decode_list(variable_value) # Decode a list
print("Encoded: ", encoded_string) # Print the results to check
print("Decoded: ", decoded_string) # Print the results to check
```
#### In Turbowarp
To encode/decode a string/list in Turbowarp, the syntax is same as to encode/decode in Scratch. See above
### Connect a Scratch Forum:
To connect a Scratch Forum use the `connect_forum_topic()` function. Use the following program to connect a Scratch
Forum:
```python
import scratchconnect
user = scratchconnect.ScratchConnect("Username", "Password")
forum = user.connect_forum_topic(forum_id=1)
forum.id() # Returns the id of the forum
forum.title() # Returns the title of the forum
forum.category() # Returns the category of the forum
forum.closed() # Returns whether the forum is closed or not
forum.deleted() # Returns whether the forum is deleted or not
forum.time() # Returns the activity of the forum
forum.post_count() # Returns the total post count of the forum
forum.follow() # Follow a Forum
forum.unfollow() # Unfollow a Forum
forum.posts(page=1) # Get the post in Forum Topic of a specified page. Images and some other stuff will not appear!
forum.ocular_reactions(post_id=123) # Get the ocular reactions of the post
forum.topic_post_history(usernames="total", segment="1", range="30") # Get the post history of the topic
##########################################################################
# IMPORTANT NOTE: To always get the updated data use the update_data() function
##########################################################################
forum.update_data() # Update the data
```
### Cloud Events
If you want to handle various Cloud Events on Scratch, use the following code:
#### In Scratch:
```python
import scratchconnect
login = scratchconnect.ScratchConnect("Username", "Password")
project = login.connect_project(1) # Connect the project
cloud = project.connect_cloud_variables() # Connect the project's cloud
event = cloud.create_cloud_event() # Create a cloud event
@event.on("connect")
def connect():
print("Connected Cloud!")
@event.on("set")
def set(data):
print("SET: ", data)
@event.on("create")
def create(data):
print("CREATE: ", data)
@event.on("delete")
def delete(data):
print("DELETE: ", data)
@event.on("disconnect")
def disconnect():
print("Disconnected from Cloud!")
event.start(update_time=1) # Start the event with update time
# To Stop a Cloud Event, use the event.stop() function
```
#### In Turbowarp:
Use the same method as in Scratch but this time connect the cloud of a project on Turbowarp
### Cloud Storage
**IMPORTANT NOTE: This feature is going to be discontinued in ScratchConect v5.0! Please use the new alternative feature: Cloud Requests.**
This is a special feature in ScratchConnect which is used to make a cloud storage system. Some features are:
* Create a variable
* Set a variable
* Get a variable
* Delete a variable
* Delete all variables
* Wait for a given time
* Simple Syntax
**Note: Maximum of 1024 characters can be set as a value to a variable. You can create any number of variables!**
**First, you need to put a sprite in your project. Go to [this link](https://scratch.mit.edu/projects/606881698/) and
click 'see inside'. There will be all the instructions.**
To create a cloud storage in ScratchConnect use the code:
```python
import scratchconnect
login = scratchconnect.ScratchConnect("Username", "Password")
project = login.connect_project(1) # Connect the project
cloud_storage = project.create_cloud_storage(file_name="data", rewrite_file=False, edit_access=[
'Sid72020123'],
all_access=False) # Create a cloud storage. It will create a file in the specified location. Then there is 'edit_access' list which contains the users which have permission to edit(actually create and delete) the variables. Use the 'rewrite_file' argument if you want the file to be re-written again each time you write the program! You can set the 'all_access' to True if you want to give all the access to all users!
cloud_storage.start_cloud_loop(update_time=1,
print_requests=True) # Start the Cloud Storage. Use the 'update_time' to wait for the specified time. Use the 'print_requests' to print the request info in the console/output screen.
```
### Cookie Login
Sometimes, the Scratch API blocks the login from online IDEs like Replit, etc. To overcome the issue, ScratchConnect
v2.5 or above has a feature to login directly with cookie. Example:
**How to get a cookie?**
You can get your cookie values by logging in with ScratchConnect locally on your computer and use the login object as ```print(login.session_id)``` to get the required cookie value. Copy the value and store it in environment variable if you are using an online IDE like Replit!
**Note: Keep this values secured and use environment variables wherever necessary.**
```python
import scratchconnect
scratch_cookie = {
"Username": "Your username",
"SessionID": "Your SessionID",
} # set the cookie dictionary
login = scratchconnect.ScratchConnect(cookie=scratch_cookie) # Login with cookie
```
**Note: While running the above code, ScratchConnect will give a warning that some features might not work if the cookie
values are wrong. It's not an ERROR, it's a WARNING**
#### Advanced
In case the login from username and password fails, ScratchConnect also has a feature to login with a cookie when the
login with username and password fails! You just have to pass the username and password value and also the cookie in the
ScratchConnect class. Also, you need to set the `auto_cookie_login` variable to `True`. Example Code:
```python
import scratchconnect
scratch_cookie = {
"Username": "Your username",
"SessionID": "Your SessionID",
} # set the cookie dictionary
login = scratchconnect.ScratchConnect(username="USERNAME", password="PASSWORD",
cookie=scratch_cookie,
auto_cookie_login=True) # Login with cookie and enable the auto_cookie_login
```
### Using ScratchConnect without login
With ScratchConnect v3.1+, you can use it without login! Example code:
```python
import scratchconnect
user = scratchconnect.ScratchConnect() # Leave all the values empty to use this library without login!
```
**Note: If you login without a username and password, some features such as setting cloud variables, etc. may not work.
It will give you a warning when you use this library without login!**
### Terminal
ScratchConnect v3.0+ has a feature called "Terminal" in which a user can get the data of Scratch User, Studio and
Project in the Python console.
To use this feature, you need to install additional dependencies required, by
typing ```pip install scratchconnect[terminal]``` in the command prompt/terminal. Then, see the example code:
```python
import scratchconnect
login = scratchconnect.ScratchConnect("Username", "Password")
terminal = login.create_new_terminal() # Create a new Terminal object
terminal.start() # Start the main terminal program
```
You can use many features in it. Just enter ```help``` to see the list of commands after the terminal starts.
### Charts
ScratchConnect v3.0+ has a feature called "Chart" in which a user can get the data of Scratch User, Studio and Project
in graphical format.
**Note: This feature uses the library ```pyhtmlchart``` to create graphs. Any other library can be used in later
versions.**
To use this feature, you need to install additional dependencies required, by
typing ```pip install scratchconnect[chart]``` in the command prompt/terminal
#### User Comparison Chart:
See the example code:
```python
import scratchconnect
login = scratchconnect.ScratchConnect("Username", "Password")
chart = login.create_new_chart() # Create a Chart object
user_chart = chart.user_stats_chart(
usernames=["griffpatch", "Will_Wam", "ScratchCat"]) # Create users stats comparison chart
user_table = chart.user_stats_table(
usernames=["griffpatch", "Will_Wam", "ScratchCat"]) # Create users stats comparison table
user_chart.open() # Open User chart
user_table.open() # Open User table
```
To include only some required data in a chart or table, use the ```include_data``` parameter of the chart or table
function and pass the value as list to get the required data.
Example: ```['Messages Count', 'Follower Count', 'Following Count']```
You can also use any one or more options from the following list:
```python
['Username', 'Messages Count', 'Follower Count', 'Following Count', 'Total Loves',
'Total Favourites', 'Total Projects Count']
```
#### Studio Comparison Chart:
See the example code:
```python
import scratchconnect
login = scratchconnect.ScratchConnect("Username", "Password")
chart = login.create_new_chart() # Create a Chart object
studio_chart = chart.studio_stats_chart(
studio_ids=[100, 101, 102]) # Create studio stats comparison chart
studio_table = chart.studio_stats_table(
studio_ids=[100, 101, 102]) # Create studio stats comparison table
studio_chart.open() # Open Studio chart
studio_table.open() # Open Studio table
```
To include only some required data in a chart or table, use the ```include_data``` parameter of the chart or table
function and pass the value as list to get the required data.
Example: ```['Comments Count', 'Followers Count', 'Managers Count']```
You can also use any one or more options from the following list:
```python
['Studio ID', 'Comments Count', 'Followers Count', 'Managers Count', 'Projects Count']
```
#### Project Comparison Chart:
See the example code:
```python
import scratchconnect
login = scratchconnect.ScratchConnect("Username", "Password")
chart = login.create_new_chart() # Create a Chart object
project_chart = chart.project_stats_chart(
project_ids=[104, 105, 106]) # Create project stats comparison chart
project_table = chart.project_stats_table(
project_ids=[104, 105, 106]) # Create project stats comparison table
project_chart.open() # Open Project chart
project_table.open() # Open Project table
```
To include only some required data in a chart or table, use the ```include_data``` parameter of the chart or table
function and pass the value as list to get the required data. Example: ```['Views', 'Loves', 'Favourites']```
You can also use any one or more options from the following list:
```python
['Project ID', 'Views', 'Loves', 'Favourites', 'Remixes', 'Version', 'Costumes', 'Blocks',
'Variables', 'Assets']
```
#### User Follower History Chart:
See the example code:
```python
import scratchconnect
login = scratchconnect.ScratchConnect("Username", "Password")
chart = login.create_new_chart() # Create a Chart object
c = chart.user_followers_history_chart(username="griffpatch") # Followers History Chart
t = chart.user_followers_history_table(username="griffpatch") # Followers History Table
c.open() # Open chart
t.open() # Open table
```
### Using ScratchConnect in online IDEs like Replit
Using the ScratchConnect version ```4.0.0+```, you can use this library even on some online IDEs like Replit!
But to keep your profile data safe, this supports only ```GET``` requests and no cookie headers are passed to the proxy (which this feature uses).
You cannot perform any actions other than ```GET```, i.e., follow a user, post a comment, etc.
But cloud variables work as it is a websocket connection.
**Remember to use environment variables to store your session ID if you are using this on an online IDE like Replit...**
To use ScratchConnect in online IDEs like Replit, you need to get your session ID (see Cookie-Login section above) and the code like:
```python
import scratchconnect
session_id = "<your session id here>"
cookie = {
"Username": "<your username>",
"SessionID": session_id
}
login = scratchconnect.ScratchConnect(online_ide_cookie=cookie) # Pass the cookie variable as a parameter to the ScratchConnect class
# Your code here...
```
### Cloud Requests
This feature was first released in version ```4.0.0``` of the ScratchConnect Python Library.
Using this, you will be able to send any amount of data to-and-from your Python program and any Scratch Project.
The docs to use this feature are [here](https://github.com/Sid72020123/scratchconnect/blob/main/CLOUD_REQUESTS.md)
### Projects made using ScratchConnect
To see the projects made using ScratchConnect, go to the
official [ScratchConnect Projects Studio](https://scratch.mit.edu/studios/30427944/)
### Bug Reporting:
All Bugs to be reported on my [Scratch Profile](https://scratch.mit.edu/users/Sid72020123/)
or [Github](https://github.com/Sid72020123/scratchconnect/issues)
### Change Log:
* 19/06/2021(v0.0.0.1) - First made the library and updated it.
* 20/06/2021(v0.1) - Added many features.
* 21/06/2021(v0.1.9) - Bug fixes.
* 26/06/2021(v0.2.0) - Made Improvements and added new features.
* 27/06/2021(v0.2.6) - Bug Fixes and update and made the 'Studio' class.
* 03/07/2021(v0.4.5) - Added many functions and made the 'Project' class.
* 04/07/2021(v0.5.0) - Update.
* 05/07/2021(v0.5.1) - Updated the messages function.
* 06/07/2021(v0.6.0) - Updated CloudConnection.
* 08/07/2021(v0.7.5) - Updated CloudConnection.
* 10/07/2021(v0.7.5) - Updated CloudConnection, made the Forum class and added DocString.
* 13/07/2021(v0.9.7) - Added DocString.
* 14/07/2021(v0.9.0) - Bug Fixes.
* 15/07/2021(v1.0) - First Release!
* 18/07/2021(V1.1) - Made the 'studio.get_projects()'.
* 19/07/2021(v1.2) - Made the get comments, curators, managers of the studio
* 13/08/2021(v1.3) - Added the get comments function
* 14/08/2021(v1.4) - Updated the get messages function
* 17/08/2021(v1.5) - Made some bug fixes
* 18/09/2021(v1.7) - Made the ScratchConnect and User Classes fast and Improved methods
* 19/09/2021(v1.8) - Made the Studio Class Faster and Improved methods
* 25/09/2021(v1.8.5) - Updated the Project and User classes
* 02/10/2021(v2.0) - Updated the Cloud and Forum Class
* 10/10/2021(v2.0.1) - Fixed some cloud stuff
* 11/10/2021(v2.1) - Added some features to Forum Class
* 24/10/2021(v2.1.1) - Started making the scStorage Class
* 29/10/2021(v2.1.1.1) - Fixed set_bio() and set_work() and updated the scDataBase
* 30/10/2021(v2.2.5) - Updated the scStorage
* 31/10/2021(v2.2.7) - Updated the scStorage
* 25/11/2021(v2.3) - Updated the scStorage and CloudConnection
* 13/12/2021(v2.3.5) - Started making the TurbowarpCloudConnection feature and added some methods to it
* 14/12/2021(v2.4) - Updated and fixed mistakes in docs
* 09/01/2022(v2.4.1) - Code Fixes
* 25/01/2022(v2.4.2) - Added new Comment API
* 16/03/2022(v2.5) - Fixed login and added cookie login feature
* 26/03/2022(v2.6) - Added some more APIs
* 27/03/2022(v2.6.3) - Added the Scratch Terminal Feature
* 28/03/2022(v2.7.5) - Updated the Scratch Terminal Feature and added the Chart Feature
* 29/03/2022(v2.8) - Updated the Charts Feature
* 16/04/2022(v3.0) - Bug fixes and improvements
* 30/04/2022(v3.0.5) - Code fix
* 01/05/2022(v3.0.8) - Code fix and new features
* 07/05/2022(v3.0.9) - Code fix
* 12/05/2022(v3.1) - Updated the CloudConnection Class
* 04/06/2022(v3.2) - Updated the ScratchConnect, CloudStorage, etc. Class
* 05/06/2022(v3.3) - Updated the CloudEvents Class, etc
* 08/06/2022(v3.3.5) - Added colored messages, etc
* 11/06/2022(v3.4) - Updated and made the CloudStorage Feature faster
* 05/08/2022(v3.4.1) - Planed and added some features of Online IDE login
* 06/08/2022(v3.4.2) - Added the OnlineIDE feature to all the Scratch API based classes
* 08/08/2022(v3.4.5) - Planned the Cloud Requests feature
* 09/08/2022(v3.5) - Added some features to the Cloud Requests Class
* 13/08/2022(v3.5.1) - Added some methods to the TurbowarpCloudConnection and CloudRequests classes and updated them
* 14/08/2022(v3.5.6) - Updated the Cloud Requests Class
* 15/08/2022(v3.6.0) - Updated the Cloud Requests Class
* 16/08/2022(v3.6.0) - Updated the Cloud Requests Class and added some logs to the class
* 20/08/2022(v3.7) - Added more logs to the Requests Class
* 21/08/2022(v3.8) - Made the scImage Class
* 27/08/2022(v3.9) - Reduced the size of encoded Image
* 30/08/2022(v3.9.5) - Bug fixes and Improvements
* 24/09/2022(v3.9.6) - Bug fixes and Improvements
* 25/09/2022(v3.9.7) - Bug fixes and Improvements
* 26/09/2022(v3.9.9) - Fixed many bugs in scCloudRequests
* 14/12/2022(v4.0.0) - Fixed the arguments bug in the Cloud Requests feature
* 15/12/2022(v4.0.0) - Bug fixes and improvements in the Cloud Requests feature
* 24/15/2022(v4.1) - Bug fixes
* 10/02/2023(v4.5) - Updated the CloudRequests feature and made it faster
* 11/02/2023(v4.5) - First stable release of the Cloud Requests feature
### Credits:
**This library is made by [@Sid72020123](https://scratch.mit.edu/users/Sid72020123/) on Scratch. Also, thanks to all
contributors.**
### Contributors:
***The names of persons below are their Scratch Usernames.***
| **Person** | **Role** | **Contribution** |
|-----------------|---------------|---------------------------------------------------------------------------------- |
| **Sid72020123** | *Owner* | Made the library and most of its features |
| **Ankit_Anmol** | *Contributor* | Fixed some things in the documentation and added some features |
| **Chiroyce** | *Contributor* | Added some features and cleaned up some code |
| **god286** | *Contributor* | Fixed mistakes in the documentation |
| **mbrick2** | *Contributor* | Fixed Badge Consistency and added the Aviate status feature |
| **AidanER1** | *Contributor* | Updated the CloudConnection class and fixed some bugs |
| **Senievol** | *Idea* | Gave the trick to make the encoded image data length much lower in Cloud Requests |
| **awesome-llama**| *Idea* | Gave the trick to make the encoded image data length much lower in Cloud Requests |
*If I'm missing some people and their work in the contributors table, please contact Sid72020123 on Scratch*
Raw data
{
"_id": null,
"home_page": "https://github.com/Sid72020123/scratchconnect/",
"name": "scratchconnect",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "connect scratch,scratch api,api,scratch,bot,scratch bot,scratch cloud,scratch cloud variables,scratch data,scratch stats,cloud requests,fast cloud requests",
"author": "Siddhesh Chavan",
"author_email": "siddheshchavan2020@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/8b/5a/21aa0986877bf23ce76a23c416e4c5d94759ae8d088dedd1085d48888054/scratchconnect-4.5.tar.gz",
"platform": null,
"description": "# ScratchConnect v4.5\n\nPython Library to connect Scratch API and much more.\n\nThis library can show the statistics of Users, Projects, Studios, Forums and also connect and set cloud variables of a\nproject!\n\n**This library needs a Scratch account. Visit the Scratch Website: [https://scratch.mit.edu/](https://scratch.mit.edu/)\nYou also need to have the Python programming language installed on your computer.**\n\n**You need basic knowledge of Python. Using this library without the knowledge can be risky.**\n\n\n\n\n[](https://pypi.org/project/scratchconnect/)\n\n\n\n### Installation\n\nTo install this library, just type ```pip install scratchconnect``` in the terminal (Command Prompt)\n\n**OR**\n\nRun this Python program\n\n```python\nimport os\n\nos.system('pip install scratchconnect')\n```\n\n**If you still have troubles while installing then go\nto [this link](https://packaging.python.org/tutorials/installing-packages/)**\n\n### Documentation\n\nDocumentation is taking a bit longer to make. It will be ready soon...\n\n### Data Credits:\n\nThese are the people who made the APIs so that this library can take data:\n\n* [Scratch API](https://github.com/LLK/scratch-rest-api) by the Scratch Team\n* [Scratch DB](https://scratchdb.lefty.one/) by [@DatOneLefty](https://scratch.mit.edu/users/DatOneLefty/) on Scratch\n* [Scratch Comments API](https://github.com/Sid72020123/Scratch-Comments-API)\n by [@Sid72020123](https://scratch.mit.edu/users/Sid72020123/) on Scratch\n* [Simple Forum API](https://github.com/Sid72020123/Scratch-Forum)\n by [@Sid72020123](https://scratch.mit.edu/users/Sid72020123/) on Scratch\n* [Ocular API](https://ocular.jeffalo.net/) by [@Jeffalo](https://scratch.mit.edu/users/Jeffalo/) on Scratch\n* [Aviate API](https://aviateapp.eu.org/) by [@NFlex23](https://scratch.mit.edu/users/NFlex23/) on Scratch\n\n```\nI thank all these people.\n- Owner (Sid72020123)\n```\n\n### Creating a Simple Connection:\n\nFollowing is a simple program to make a simple connection:\n\n**Note: Don't put the username and password as it is when you host or share the code with others. While hosting, you can\nuse environment variables and while sharing, you can remove the username and password values. This will help in keeping\nthe password and other important things secured.**\n\n```python\nimport scratchconnect\n\nuser = scratchconnect.ScratchConnect(\"Username\", \"Password\")\n```\n\nIt will give an error if the `username` or `password` is invalid.\n\n### More Uses:\n\n##### Note: Some of the functions below can be only used by the logged in Scratcher. To get the stats of other users see the User Connection Documentation\n\n```python\nimport scratchconnect\n\nuser = scratchconnect.ScratchConnect(\"Username\", \"Password\")\nuser.id() # Returns the ID of the user\nuser.thumbnail_url() # Returns the thumbnail URL of a user\nuser.messages_count() # Returns the messages count of the user\nuser.messages(all=False, limit=20, offset=0, filter=\"all\") # Returns the messages\nuser.clear_messages() # Clear your messages\nuser.my_stuff_projects(order=\"all\", page=1, sort_by=\"\") # Get/Sort mystuff projects\nuser.work() # Returns the 'What I am working on' of a Scratch profile\nuser.bio() # Returns the 'About me' of a Scratch profile\nuser.status() # Returns the status(Scratcher or New Scratcher) of a Scratch profile\nuser.joined_date() # Returns the joined date of a Scratch profile\nuser.country() # Returns the country of a Scratch profile\nuser.featured_data() # Returns the featured project data of the Scratch profile\nuser.projects() # Returns the list of shared projects of a user\nuser.followers_count() # Returns the follower count of a user\nuser.following_count() # Returns the following count of a user\nuser.total_views() # Returns the total views count of all the shared projects of a user\nuser.total_loves_count() # Returns the total loves count of all the shared projects of a user\nuser.total_favourites_count() # Returns the total favourites count of all the shared projects of a user\nuser.following() # Returns the list of the user following\nuser.followers() # Returns the list of the user followers\nuser.favourites() # Returns the list of the user favourites\nuser.toggle_commenting() # Toggle the commenting of the profile\nuser.follow_user(username=\"Sid72020123\") # Follow a user\nuser.unfollow_user(username=\"Sid72020123\") # UnFollow a user\nuser.set_bio(content=\"Hi!\") # Set the bio or 'About Me' of the profile\nuser.set_work(content=\"Hi!\") # Set the status or 'What I am Working On' of the profile\nuser.all_data() # Returns all the data of the user\nuser.site_health() # Returns the health of the Scratch Website.\nuser.site_news() # Returns the news of the Scratch Website.\nuser.site_front_page_projects() # Returns the front page projects of the Scratch Website.\nuser.explore_projects(mode=\"trending\", query=\"*\") # Explore the projects\nuser.explore_studios(mode=\"trending\", query=\"*\") # Explore the studios\nuser.search_projects(mode=\"trending\", search=\"*\") # Search the projects\nuser.search_studios(mode=\"trending\", search=\"*\") # Search the studios\nuser.set_featured_project(project_id=\"1\", label='featured_project') # Set the 'Featured Project' of a Scratch Profile\nuser.user_follower_history() # Return the follower history of the user\nuser.comments(limit=5, page=1) # Get comments of the profile of the user\nuser.ocular_data() # Returns the ocular data of the user\nuser.aviate_data(code=False) # Returns the Aviate Status of the user\nuser.search_forum(q=\"Hi!\", order=\"relevance\", page=0) # Search the forum\n##########################################################################\n# IMPORTANT NOTE: To always get the updated data use the update_data() function\n##########################################################################\nuser.update_data() # Update the data\n```\n\n### Connect a Scratch User:\n\nTo connect a Scratch User use the `connect_user()` function. Use the following program to connect a Scratch User:\n\n```python\nimport scratchconnect\n\nlogin = scratchconnect.ScratchConnect(\"Username\", \"Password\")\nuser = login.connect_user(username=\"Sid72020123\")\nuser.id() # Returns the ID of the user\nuser.thumbnail_url() # Returns the thumbnail URL of a user\nuser.messages_count() # Returns the messages count of the user\nuser.work() # Returns the 'What I am working on' of a Scratch profile\nuser.bio() # Returns the 'About me' of a Scratch profile\nuser.status() # Returns the status(Scratcher or New Scratcher) of a Scratch profile\nuser.joined_date() # Returns the joined date of a Scratch profile\nuser.country() # Returns the country of a Scratch profile\nuser.featured_data() # Returns the featured project data of the Scratch profile\nuser.projects() # Returns the list of shared projects of a user\nuser.followers_count() # Returns the follower count of a user\nuser.following_count() # Returns the following count of a user\nuser.total_views_count() # Returns the total views count of all the shared projects of a user\nuser.total_loves_count() # Returns the total loves count of all the shared projects of a user\nuser.total_favourites_count() # Returns the total favourites count of all the shared projects of a user\nuser.following() # Returns the list of the user following\nuser.followers() # Returns the list of the user followers\nuser.favourites() # Returns the list of the user favourites\nuser.user_follower_history() # Return the follower history of the user\nuser.post_comment(content=\"Hi!\") # Post a comment on the user's profile\nuser.report(field=\"\") # Report a user\nuser.reply_comment(content=\"Hi!\", comment_id=1) # Reply a comment\nuser.all_data() # Returns all the data of the user\nuser.comments(limit=5, page=1) # Get comments of the profile of the user\nuser.ocular_data() # Returns the ocular data of the user\nuser.aviate_data(code=False) # Returns the Aviate Status of the user\n##########################################################################\n# IMPORTANT NOTE: To always get the updated data use the update_data() function\n##########################################################################\nuser.update_data() # Update the data\n```\n\n### Connect a Scratch Studio:\n\nTo connect a Scratch Studio use the `connect_studio()` function. Use the following program to connect a Scratch Studio:\n\n```python\nimport scratchconnect\n\nuser = scratchconnect.ScratchConnect(\"Username\", \"Password\")\nstudio = user.connect_studio(studio_id=1)\nstudio.id() # Returns the studio ID\nstudio.title() # Returns the studio title\nstudio.host_id() # Returns the studio owner/host ID\nstudio.description() # Returns the studio description\nstudio.visibility() # Returns the studio visibility\nstudio.is_public() # Returns whether a studio is public\nstudio.is_open_to_all() # Returns whether a studio is open to all\nstudio.are_comments_allowed() # Returns whether a studio has comments allowed\nstudio.history() # Returns the history of the studio\nstudio.stats() # Returns the stats of the studio\nstudio.thumbnail_url() # Returns the thumbnail URL of the studio\nstudio.add_project(project_id=1) # Add a project to a studio\nstudio.remove_project(project_id=1) # Remove a project from a studio\nstudio.open_to_public() # Open the studio to public\nstudio.close_to_public() # Close the studio to public\nstudio.follow_studio() # Follow the studio\nstudio.unfollow_studio() # UnFollow the studio\nstudio.toggle_commenting() # Toggle the commenting of the studio\nstudio.post_comment(content=\"Hi!\") # Post comment in the studio\nstudio.reply_comment(content=\"Hi!\", comment_id=1) # Reply a comment in a studio\nstudio.delete_comment() # Delete comment in the studio\nstudio.report_comment(comment_id=1) # Report comment in the studio\nstudio.invite_curator(username=\"Sid72020123\") # Invite a user to the studio\nstudio.accept_curator() # Accept the curator invitation in a studio\nstudio.promote_curator(username=\"Sid72020123\") # Promote a user in the studio\nstudio.set_description(content=\"Hi!\") # Set the description of a Studio\nstudio.set_title(content=\"Hi!\") # Set the title of a Studio\nstudio.projects(all=False, limit=40, offset=0) # Get the projects of the studio\nstudio.comments(all=False, limit=40, offset=0) # Get the comments of the studio\nstudio.curators(all=False, limit=40, offset=0) # Get the curators of the studio\nstudio.managers(all=False, limit=40, offset=0) # Get the managers of the studio\nstudio.activity(all=False, limit=40, offset=0) # Get the activity of the studio\nstudio.all_data() # Returns all the data of a Scratch Studio\n##########################################################################\n# IMPORTANT NOTE: To always get the updated data use the update_data() function\n##########################################################################\nstudio.update_data() # Update the data\n```\n\n### Connect a Scratch Project:\n\nTo connect a Scratch Project use the `connect_project()` function. Use the following program to connect a Scratch\nProject:\n\n```python\nimport scratchconnect\n\nuser = scratchconnect.ScratchConnect(\"Username\", \"Password\")\nproject = user.connect_project(project_id=1) # Connect a project.\nproject.author() # Returns the author of the project\nproject.title() # Returns the title of the project\nproject.notes() # Returns the notes(Notes or Credits) of the project\nproject.instruction() # Returns the instructions of the project\nproject.are_comments_allowed() # Returns whether the comments are allowed in a project\nproject.stats() # Returns the stats of a project\nproject.history() # Returns the history of a project\nproject.remix_data() # Returns the remix data of a project\nproject.visibility() # Returns whether the project is visible\nproject.is_public() # Returns whether the project is public\nproject.is_published() # Returns whether the project is published\nproject.thumbnail_url() # Returns the thumbnail url of a project\nproject.assets_info() # Returns the Assets info of a project\nproject.scripts() # Returns the scripts of a project\nproject.love() # Love a project\nproject.unlove() # UnLove a project\nproject.favourite() # Favourite a project\nproject.unfavourite() # UnFavourite a project\nproject.comments(all=False, limit=40, offset=0, comment_id=None) # Returns the list of comments of a project\nproject.remixes(all=False, limit=20, offset=0) # Returns the list of remixes of a project\nproject.post_comment(content=\"Hi!\") # Post a comment\nproject.reply_comment(content=\"Hi!\", comment_id=1) # Reply a comment\nproject.toggle_commenting() # Toggle the commenting of a project\nproject.turn_on_commenting() # Turn On the commenting of a project\nproject.turn_off_commenting() # Turn Off the commenting of a project\nproject.report(category=\"\", reason=\"\") # Report a project\nproject.unshare() # Unshare a project\nproject.view() # Just view a project\nproject.set_thumbnail(file=\"\") # Set the thumbnail of a project\nproject.delete_comment(comment_id=1) # Delete a comment\nproject.report_comment(comment_id=1) # Report a comment\nproject.reply_comment(comment_id=1, content=\"Hi!\") # Reply a comment\nproject.set_title() # Set the title of the project\nproject.set_description() # Set the description of the project\nproject.set_instruction() # Set the instruction of the project\nproject.all_data() # Returns all the data of a Scratch Project\n##########################################################################\n# IMPORTANT NOTE: To always get the updated data use the update_data() function\n##########################################################################\nproject.update_data() # Update the data\n```\n\n#### Want to access and set the cloud variables of an unshared project?\n\nUse the Following Code:\n\n**Note: By accessing an unshared project, some data may not be accessible to this library so some data might not appear.\nYou can get the scripts and connect cloud variables of an unshared project.**\n\n```python\nimport scratchconnect\n\nuser = scratchconnect.ScratchConnect(\"Username\", \"Password\")\nproject = user.connect_project(project_id=1,\n access_unshared=True) # Use the 'access_unshared' parameter to access the unshared project.\n```\n\n### Connect Cloud Variables of a Scratch Project:\n\nTo connect the cloud variables of a Scratch Project use the `connect_cloud_variables()` function. Use the following\nprogram to connect the cloud variables of a Scratch Project:\n\n```python\nimport scratchconnect\n\nuser = scratchconnect.ScratchConnect(\"Username\", \"Password\")\nproject = user.connect_project(project_id=1)\nvariables = project.connect_cloud_variables()\nvariables.get_variable_data(limit=100, offset=0) # Returns the cloud variable data\nvariables.get_cloud_variable_value(variable_name=\"Name\", limit=100) # Returns the cloud variable value\n# Program to set cloud variables:\nset = variables.set_cloud_variable(variable_name=\"Name\", value=123) # Set a Cloud Variable\nif set:\n print(\"Cloud Variable Updated!\")\n```\n\n### Connect Cloud Variables of Turbowarp:\n\nTo connect the cloud variables of a Turbowarp Project use the `connect_turbowarp_cloud()` function. Use the following\nprogram to connect the cloud variables of a Turbowarp Project:\n\n**Note: Turbowarp doesn't provide any features to get the data, etc. so you can't do some actions with Turbowarp as in\nScratch**\n\n**Note: Use the ```acccess_unshared=True``` parameter of the ```connect_project()``` function to connect the Turbowarp\nProject even if it is unshared on Scratch!**\n\n```python\nimport scratchconnect\n\nuser = scratchconnect.ScratchConnect(\"Username\", \"Password\")\nproject = user.connect_project(project_id=1) # Connect a Project\ntw_cloud = project.connect_turbowarp_cloud(\n username=\"Username\") # Connect the Turbowarp cloud with an optional parameter to change the username!\n\ntw_cloud.set_cloud_variable(variable_name=\"Name\", value=0) # Set a Turbowarp variable\n\ntw_cloud.get_variable_data() # Get the data of the previous value of the variable. NOT Current\n```\n\n### Error with Turbowarp Cloud?\n\nSometimes there mat be error with the Turbowarp Cloud. Some Basic Errors are:\n\n**1. I can't change the Cloud Variable Value**\n\nIf you can't change the Turbowarp Cloud Variable value using scratchconnect then first check if your code is correct. If\nthe problem still exists try with this\nURL: ```https://turbowarp.org/<project ID>?cloud_host=wss://clouddata.turbowarp.org```. Replace the ```project ID```\nwith your project ID.\n\n### Encoding/Decoding Cloud Variables:\n\n#### In Scratch\n\nScratchConnect v2.0+ has some good features to encode/decode a cloud variable! See some examples below:\n\n**ScratchConnect has a case-sensitive encoding/decoding system. For example both 'A' and 'a' are encoded/decoded\ndifferently!**\n\nGo to [this link](https://scratch.mit.edu/projects/578255313/) for the Scratch version of Encoder/Decoder\n\n##### Encoding/Decoding a string:\n\n```python\nimport scratchconnect\n\nlogin = scratchconnect.ScratchConnect(\"Username\", \"Password\")\nproject = login.connect_project(1) # Connect the project\n\nvariables = project.connect_cloud_variables() # Connect the project's cloud variables\n\nencoded_string = variables.encode(\"Hi! This is a text!\") # Encode a string\n\nvariables.set_cloud_variable(variable_name='Name', value=encoded_string)\nvariable_value = variables.get_cloud_variable_value(variable_name='Name')[0] # Get the variable value\n\ndecoded_string = variables.decode(variable_value) # Decode a string\n\nprint(\"Encoded: \", encoded_string) # Print the results to check\nprint(\"Decoded: \", decoded_string) # Print the results to check\n```\n\n##### Encoding/Decoding a list:\n\n```python\nimport scratchconnect\n\nlogin = scratchconnect.ScratchConnect(\"Username\", \"Password\")\nproject = login.connect_project(1) # Connect the project\n\nvariables = project.connect_cloud_variables() # Connect the project's cloud variables\n\ndata = ['A', 'B', 'C']\nencoded_string = variables.encode_list(data) # Encode a list\n\nvariables.set_cloud_variable(variable_name='Name', value=encoded_string)\nvariable_value = variables.get_cloud_variable_value(variable_name='Name')[0] # Get the variable value\n\ndecoded_string = variables.decode_list(variable_value) # Decode a list\n\nprint(\"Encoded: \", encoded_string) # Print the results to check\nprint(\"Decoded: \", decoded_string) # Print the results to check\n```\n\n#### In Turbowarp\n\nTo encode/decode a string/list in Turbowarp, the syntax is same as to encode/decode in Scratch. See above\n\n### Connect a Scratch Forum:\n\nTo connect a Scratch Forum use the `connect_forum_topic()` function. Use the following program to connect a Scratch\nForum:\n\n```python\nimport scratchconnect\n\nuser = scratchconnect.ScratchConnect(\"Username\", \"Password\")\nforum = user.connect_forum_topic(forum_id=1)\nforum.id() # Returns the id of the forum\nforum.title() # Returns the title of the forum\nforum.category() # Returns the category of the forum\nforum.closed() # Returns whether the forum is closed or not\nforum.deleted() # Returns whether the forum is deleted or not\nforum.time() # Returns the activity of the forum\nforum.post_count() # Returns the total post count of the forum\nforum.follow() # Follow a Forum\nforum.unfollow() # Unfollow a Forum\nforum.posts(page=1) # Get the post in Forum Topic of a specified page. Images and some other stuff will not appear!\nforum.ocular_reactions(post_id=123) # Get the ocular reactions of the post\nforum.topic_post_history(usernames=\"total\", segment=\"1\", range=\"30\") # Get the post history of the topic\n##########################################################################\n# IMPORTANT NOTE: To always get the updated data use the update_data() function\n##########################################################################\nforum.update_data() # Update the data\n```\n\n### Cloud Events\n\nIf you want to handle various Cloud Events on Scratch, use the following code:\n\n#### In Scratch:\n\n```python\nimport scratchconnect\n\nlogin = scratchconnect.ScratchConnect(\"Username\", \"Password\")\n\nproject = login.connect_project(1) # Connect the project\n\ncloud = project.connect_cloud_variables() # Connect the project's cloud\n\nevent = cloud.create_cloud_event() # Create a cloud event\n\n\n@event.on(\"connect\")\ndef connect():\n print(\"Connected Cloud!\")\n\n\n@event.on(\"set\")\ndef set(data):\n print(\"SET: \", data)\n\n\n@event.on(\"create\")\ndef create(data):\n print(\"CREATE: \", data)\n\n\n@event.on(\"delete\")\ndef delete(data):\n print(\"DELETE: \", data)\n\n\n@event.on(\"disconnect\")\ndef disconnect():\n print(\"Disconnected from Cloud!\")\n\n\nevent.start(update_time=1) # Start the event with update time\n\n# To Stop a Cloud Event, use the event.stop() function\n```\n\n#### In Turbowarp:\n\nUse the same method as in Scratch but this time connect the cloud of a project on Turbowarp\n\n### Cloud Storage\n\n**IMPORTANT NOTE: This feature is going to be discontinued in ScratchConect v5.0! Please use the new alternative feature: Cloud Requests.**\n\nThis is a special feature in ScratchConnect which is used to make a cloud storage system. Some features are:\n\n* Create a variable\n* Set a variable\n* Get a variable\n* Delete a variable\n* Delete all variables\n* Wait for a given time\n* Simple Syntax\n\n**Note: Maximum of 1024 characters can be set as a value to a variable. You can create any number of variables!**\n\n**First, you need to put a sprite in your project. Go to [this link](https://scratch.mit.edu/projects/606881698/) and\nclick 'see inside'. There will be all the instructions.**\n\nTo create a cloud storage in ScratchConnect use the code:\n\n```python\nimport scratchconnect\n\nlogin = scratchconnect.ScratchConnect(\"Username\", \"Password\")\nproject = login.connect_project(1) # Connect the project\n\ncloud_storage = project.create_cloud_storage(file_name=\"data\", rewrite_file=False, edit_access=[\n 'Sid72020123'],\n all_access=False) # Create a cloud storage. It will create a file in the specified location. Then there is 'edit_access' list which contains the users which have permission to edit(actually create and delete) the variables. Use the 'rewrite_file' argument if you want the file to be re-written again each time you write the program! You can set the 'all_access' to True if you want to give all the access to all users!\n\ncloud_storage.start_cloud_loop(update_time=1,\n print_requests=True) # Start the Cloud Storage. Use the 'update_time' to wait for the specified time. Use the 'print_requests' to print the request info in the console/output screen.\n```\n\n### Cookie Login\n\nSometimes, the Scratch API blocks the login from online IDEs like Replit, etc. To overcome the issue, ScratchConnect\nv2.5 or above has a feature to login directly with cookie. Example:\n\n**How to get a cookie?**\nYou can get your cookie values by logging in with ScratchConnect locally on your computer and use the login object as ```print(login.session_id)``` to get the required cookie value. Copy the value and store it in environment variable if you are using an online IDE like Replit!\n\n**Note: Keep this values secured and use environment variables wherever necessary.**\n\n```python\nimport scratchconnect\n\nscratch_cookie = {\n \"Username\": \"Your username\",\n \"SessionID\": \"Your SessionID\",\n} # set the cookie dictionary\n\nlogin = scratchconnect.ScratchConnect(cookie=scratch_cookie) # Login with cookie\n```\n\n**Note: While running the above code, ScratchConnect will give a warning that some features might not work if the cookie\nvalues are wrong. It's not an ERROR, it's a WARNING**\n\n#### Advanced\n\nIn case the login from username and password fails, ScratchConnect also has a feature to login with a cookie when the\nlogin with username and password fails! You just have to pass the username and password value and also the cookie in the\nScratchConnect class. Also, you need to set the `auto_cookie_login` variable to `True`. Example Code:\n\n```python\nimport scratchconnect\n\nscratch_cookie = {\n \"Username\": \"Your username\",\n \"SessionID\": \"Your SessionID\",\n} # set the cookie dictionary\n\nlogin = scratchconnect.ScratchConnect(username=\"USERNAME\", password=\"PASSWORD\",\n cookie=scratch_cookie,\n auto_cookie_login=True) # Login with cookie and enable the auto_cookie_login\n```\n\n### Using ScratchConnect without login\n\nWith ScratchConnect v3.1+, you can use it without login! Example code:\n\n```python\nimport scratchconnect\n\nuser = scratchconnect.ScratchConnect() # Leave all the values empty to use this library without login!\n```\n\n**Note: If you login without a username and password, some features such as setting cloud variables, etc. may not work.\nIt will give you a warning when you use this library without login!**\n\n### Terminal\n\nScratchConnect v3.0+ has a feature called \"Terminal\" in which a user can get the data of Scratch User, Studio and\nProject in the Python console.\n\nTo use this feature, you need to install additional dependencies required, by\ntyping ```pip install scratchconnect[terminal]``` in the command prompt/terminal. Then, see the example code:\n\n```python\nimport scratchconnect\n\nlogin = scratchconnect.ScratchConnect(\"Username\", \"Password\")\n\nterminal = login.create_new_terminal() # Create a new Terminal object\nterminal.start() # Start the main terminal program\n```\n\nYou can use many features in it. Just enter ```help``` to see the list of commands after the terminal starts.\n\n### Charts\n\nScratchConnect v3.0+ has a feature called \"Chart\" in which a user can get the data of Scratch User, Studio and Project\nin graphical format.\n\n**Note: This feature uses the library ```pyhtmlchart``` to create graphs. Any other library can be used in later\nversions.**\n\nTo use this feature, you need to install additional dependencies required, by\ntyping ```pip install scratchconnect[chart]``` in the command prompt/terminal\n\n#### User Comparison Chart:\n\nSee the example code:\n\n```python\nimport scratchconnect\n\nlogin = scratchconnect.ScratchConnect(\"Username\", \"Password\")\n\nchart = login.create_new_chart() # Create a Chart object\n\nuser_chart = chart.user_stats_chart(\n usernames=[\"griffpatch\", \"Will_Wam\", \"ScratchCat\"]) # Create users stats comparison chart\n\nuser_table = chart.user_stats_table(\n usernames=[\"griffpatch\", \"Will_Wam\", \"ScratchCat\"]) # Create users stats comparison table\n\nuser_chart.open() # Open User chart\nuser_table.open() # Open User table\n```\n\nTo include only some required data in a chart or table, use the ```include_data``` parameter of the chart or table\nfunction and pass the value as list to get the required data.\nExample: ```['Messages Count', 'Follower Count', 'Following Count']```\n\nYou can also use any one or more options from the following list:\n\n```python\n['Username', 'Messages Count', 'Follower Count', 'Following Count', 'Total Loves',\n 'Total Favourites', 'Total Projects Count']\n```\n\n#### Studio Comparison Chart:\n\nSee the example code:\n\n```python\nimport scratchconnect\n\nlogin = scratchconnect.ScratchConnect(\"Username\", \"Password\")\n\nchart = login.create_new_chart() # Create a Chart object\n\nstudio_chart = chart.studio_stats_chart(\n studio_ids=[100, 101, 102]) # Create studio stats comparison chart\n\nstudio_table = chart.studio_stats_table(\n studio_ids=[100, 101, 102]) # Create studio stats comparison table\n\nstudio_chart.open() # Open Studio chart\nstudio_table.open() # Open Studio table\n```\n\nTo include only some required data in a chart or table, use the ```include_data``` parameter of the chart or table\nfunction and pass the value as list to get the required data.\nExample: ```['Comments Count', 'Followers Count', 'Managers Count']```\n\nYou can also use any one or more options from the following list:\n\n```python\n['Studio ID', 'Comments Count', 'Followers Count', 'Managers Count', 'Projects Count']\n```\n\n#### Project Comparison Chart:\n\nSee the example code:\n\n```python\nimport scratchconnect\n\nlogin = scratchconnect.ScratchConnect(\"Username\", \"Password\")\n\nchart = login.create_new_chart() # Create a Chart object\n\nproject_chart = chart.project_stats_chart(\n project_ids=[104, 105, 106]) # Create project stats comparison chart\n\nproject_table = chart.project_stats_table(\n project_ids=[104, 105, 106]) # Create project stats comparison table\n\nproject_chart.open() # Open Project chart\nproject_table.open() # Open Project table\n```\n\nTo include only some required data in a chart or table, use the ```include_data``` parameter of the chart or table\nfunction and pass the value as list to get the required data. Example: ```['Views', 'Loves', 'Favourites']```\n\nYou can also use any one or more options from the following list:\n\n```python\n['Project ID', 'Views', 'Loves', 'Favourites', 'Remixes', 'Version', 'Costumes', 'Blocks',\n 'Variables', 'Assets']\n```\n\n#### User Follower History Chart:\n\nSee the example code:\n\n```python\nimport scratchconnect\n\nlogin = scratchconnect.ScratchConnect(\"Username\", \"Password\")\n\nchart = login.create_new_chart() # Create a Chart object\n\nc = chart.user_followers_history_chart(username=\"griffpatch\") # Followers History Chart\n\nt = chart.user_followers_history_table(username=\"griffpatch\") # Followers History Table\n\nc.open() # Open chart\nt.open() # Open table\n```\n\n### Using ScratchConnect in online IDEs like Replit\n\nUsing the ScratchConnect version ```4.0.0+```, you can use this library even on some online IDEs like Replit!\n\nBut to keep your profile data safe, this supports only ```GET``` requests and no cookie headers are passed to the proxy (which this feature uses).\nYou cannot perform any actions other than ```GET```, i.e., follow a user, post a comment, etc.\n\nBut cloud variables work as it is a websocket connection.\n\n**Remember to use environment variables to store your session ID if you are using this on an online IDE like Replit...**\n\nTo use ScratchConnect in online IDEs like Replit, you need to get your session ID (see Cookie-Login section above) and the code like:\n```python\nimport scratchconnect\n\nsession_id = \"<your session id here>\"\ncookie = {\n \"Username\": \"<your username>\",\n \"SessionID\": session_id\n}\n\nlogin = scratchconnect.ScratchConnect(online_ide_cookie=cookie) # Pass the cookie variable as a parameter to the ScratchConnect class\n\n# Your code here...\n```\n\n### Cloud Requests\n\nThis feature was first released in version ```4.0.0``` of the ScratchConnect Python Library.\nUsing this, you will be able to send any amount of data to-and-from your Python program and any Scratch Project.\n\nThe docs to use this feature are [here](https://github.com/Sid72020123/scratchconnect/blob/main/CLOUD_REQUESTS.md)\n\n### Projects made using ScratchConnect\n\nTo see the projects made using ScratchConnect, go to the\nofficial [ScratchConnect Projects Studio](https://scratch.mit.edu/studios/30427944/)\n\n### Bug Reporting:\n\nAll Bugs to be reported on my [Scratch Profile](https://scratch.mit.edu/users/Sid72020123/)\nor [Github](https://github.com/Sid72020123/scratchconnect/issues)\n\n### Change Log:\n\n* 19/06/2021(v0.0.0.1) - First made the library and updated it.\n* 20/06/2021(v0.1) - Added many features.\n* 21/06/2021(v0.1.9) - Bug fixes.\n* 26/06/2021(v0.2.0) - Made Improvements and added new features.\n* 27/06/2021(v0.2.6) - Bug Fixes and update and made the 'Studio' class.\n* 03/07/2021(v0.4.5) - Added many functions and made the 'Project' class.\n* 04/07/2021(v0.5.0) - Update.\n* 05/07/2021(v0.5.1) - Updated the messages function.\n* 06/07/2021(v0.6.0) - Updated CloudConnection.\n* 08/07/2021(v0.7.5) - Updated CloudConnection.\n* 10/07/2021(v0.7.5) - Updated CloudConnection, made the Forum class and added DocString.\n* 13/07/2021(v0.9.7) - Added DocString.\n* 14/07/2021(v0.9.0) - Bug Fixes.\n* 15/07/2021(v1.0) - First Release!\n* 18/07/2021(V1.1) - Made the 'studio.get_projects()'.\n* 19/07/2021(v1.2) - Made the get comments, curators, managers of the studio\n* 13/08/2021(v1.3) - Added the get comments function\n* 14/08/2021(v1.4) - Updated the get messages function\n* 17/08/2021(v1.5) - Made some bug fixes\n* 18/09/2021(v1.7) - Made the ScratchConnect and User Classes fast and Improved methods\n* 19/09/2021(v1.8) - Made the Studio Class Faster and Improved methods\n* 25/09/2021(v1.8.5) - Updated the Project and User classes\n* 02/10/2021(v2.0) - Updated the Cloud and Forum Class\n* 10/10/2021(v2.0.1) - Fixed some cloud stuff\n* 11/10/2021(v2.1) - Added some features to Forum Class\n* 24/10/2021(v2.1.1) - Started making the scStorage Class\n* 29/10/2021(v2.1.1.1) - Fixed set_bio() and set_work() and updated the scDataBase\n* 30/10/2021(v2.2.5) - Updated the scStorage\n* 31/10/2021(v2.2.7) - Updated the scStorage\n* 25/11/2021(v2.3) - Updated the scStorage and CloudConnection\n* 13/12/2021(v2.3.5) - Started making the TurbowarpCloudConnection feature and added some methods to it\n* 14/12/2021(v2.4) - Updated and fixed mistakes in docs\n* 09/01/2022(v2.4.1) - Code Fixes\n* 25/01/2022(v2.4.2) - Added new Comment API\n* 16/03/2022(v2.5) - Fixed login and added cookie login feature\n* 26/03/2022(v2.6) - Added some more APIs\n* 27/03/2022(v2.6.3) - Added the Scratch Terminal Feature\n* 28/03/2022(v2.7.5) - Updated the Scratch Terminal Feature and added the Chart Feature\n* 29/03/2022(v2.8) - Updated the Charts Feature\n* 16/04/2022(v3.0) - Bug fixes and improvements\n* 30/04/2022(v3.0.5) - Code fix\n* 01/05/2022(v3.0.8) - Code fix and new features\n* 07/05/2022(v3.0.9) - Code fix\n* 12/05/2022(v3.1) - Updated the CloudConnection Class\n* 04/06/2022(v3.2) - Updated the ScratchConnect, CloudStorage, etc. Class\n* 05/06/2022(v3.3) - Updated the CloudEvents Class, etc\n* 08/06/2022(v3.3.5) - Added colored messages, etc\n* 11/06/2022(v3.4) - Updated and made the CloudStorage Feature faster\n* 05/08/2022(v3.4.1) - Planed and added some features of Online IDE login\n* 06/08/2022(v3.4.2) - Added the OnlineIDE feature to all the Scratch API based classes\n* 08/08/2022(v3.4.5) - Planned the Cloud Requests feature\n* 09/08/2022(v3.5) - Added some features to the Cloud Requests Class\n* 13/08/2022(v3.5.1) - Added some methods to the TurbowarpCloudConnection and CloudRequests classes and updated them\n* 14/08/2022(v3.5.6) - Updated the Cloud Requests Class\n* 15/08/2022(v3.6.0) - Updated the Cloud Requests Class\n* 16/08/2022(v3.6.0) - Updated the Cloud Requests Class and added some logs to the class\n* 20/08/2022(v3.7) - Added more logs to the Requests Class\n* 21/08/2022(v3.8) - Made the scImage Class\n* 27/08/2022(v3.9) - Reduced the size of encoded Image\n* 30/08/2022(v3.9.5) - Bug fixes and Improvements\n* 24/09/2022(v3.9.6) - Bug fixes and Improvements\n* 25/09/2022(v3.9.7) - Bug fixes and Improvements\n* 26/09/2022(v3.9.9) - Fixed many bugs in scCloudRequests\n* 14/12/2022(v4.0.0) - Fixed the arguments bug in the Cloud Requests feature\n* 15/12/2022(v4.0.0) - Bug fixes and improvements in the Cloud Requests feature\n* 24/15/2022(v4.1) - Bug fixes\n* 10/02/2023(v4.5) - Updated the CloudRequests feature and made it faster\n* 11/02/2023(v4.5) - First stable release of the Cloud Requests feature\n\n### Credits:\n\n**This library is made by [@Sid72020123](https://scratch.mit.edu/users/Sid72020123/) on Scratch. Also, thanks to all\ncontributors.**\n\n### Contributors:\n\n***The names of persons below are their Scratch Usernames.***\n\n| **Person** | **Role** | **Contribution** |\n|-----------------|---------------|---------------------------------------------------------------------------------- |\n| **Sid72020123** | *Owner* | Made the library and most of its features |\n| **Ankit_Anmol** | *Contributor* | Fixed some things in the documentation and added some features |\n| **Chiroyce** | *Contributor* | Added some features and cleaned up some code |\n| **god286** | *Contributor* | Fixed mistakes in the documentation |\n| **mbrick2** | *Contributor* | Fixed Badge Consistency and added the Aviate status feature |\n| **AidanER1** | *Contributor* | Updated the CloudConnection class and fixed some bugs |\n| **Senievol** | *Idea* | Gave the trick to make the encoded image data length much lower in Cloud Requests |\n| **awesome-llama**| *Idea* | Gave the trick to make the encoded image data length much lower in Cloud Requests |\n\n*If I'm missing some people and their work in the contributors table, please contact Sid72020123 on Scratch*\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python Library to connect Scratch API and much more. This library can show the statistics of Users, Projects, Studios, Forums and also connect and set cloud variables of a project!",
"version": "4.5",
"split_keywords": [
"connect scratch",
"scratch api",
"api",
"scratch",
"bot",
"scratch bot",
"scratch cloud",
"scratch cloud variables",
"scratch data",
"scratch stats",
"cloud requests",
"fast cloud requests"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9b9f5e6527402b2be9817aee79ed3bbf016ce0f873699d29e9a76508ec8b7be8",
"md5": "d27808911b88d1204105731e851829ad",
"sha256": "f7f86d177db3978eadb372327467e07ba6be678637967a22cd1820ed885dafc1"
},
"downloads": -1,
"filename": "scratchconnect-4.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d27808911b88d1204105731e851829ad",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 42107,
"upload_time": "2023-02-11T07:24:14",
"upload_time_iso_8601": "2023-02-11T07:24:14.172186Z",
"url": "https://files.pythonhosted.org/packages/9b/9f/5e6527402b2be9817aee79ed3bbf016ce0f873699d29e9a76508ec8b7be8/scratchconnect-4.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8b5a21aa0986877bf23ce76a23c416e4c5d94759ae8d088dedd1085d48888054",
"md5": "aeea3819267d59f405e0983698fdb5f6",
"sha256": "9389a685e95276925c961ab87d6ebb276b3d0e91f987f8e9dcaa2f377da120cc"
},
"downloads": -1,
"filename": "scratchconnect-4.5.tar.gz",
"has_sig": false,
"md5_digest": "aeea3819267d59f405e0983698fdb5f6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 51576,
"upload_time": "2023-02-11T07:24:16",
"upload_time_iso_8601": "2023-02-11T07:24:16.521635Z",
"url": "https://files.pythonhosted.org/packages/8b/5a/21aa0986877bf23ce76a23c416e4c5d94759ae8d088dedd1085d48888054/scratchconnect-4.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-11 07:24:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "Sid72020123",
"github_project": "scratchconnect",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "scratchconnect"
}
JSON
