Metadata-Version: 2.1
Name: scratch-websocket-api
Version: 0.1.7
Summary: A API for scratch with websocket
Author-email: yossy4411 <yossy4411.dev@gmail.com>
Project-URL: Homepage, https://github.com/yossy4411/ScratchWebsocketAPI
Project-URL: Bug Tracker, https://github.com/yossy4411/ScratchWebsocketAPI/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE


# Scratch Websocket API #  
## Overview
このライブラリは、Websocketを通じてScratch（またはTurbowarp）に接続し、そのクラウド変数を変更するために作成されました。  
制作者: [yosshi---](https://scratch.mit.edu/users/yosshi---)
## Installation 
Python3が必須となります。Python2は使えないと思います。
```bash  
pip install scratch-websocket-api websocket-client requests
```  
websocket-clientとrequestsはこのライブラリで必要なのでインストールしてください。
## Usage  
### Connect  
Websocketを使用してサーバーに接続します  
```python  
import scratch_api.scratch_ws_api as scratch3  
conn = scratch3.login("USERNAME", "PASSWORD").connect(ProjectID, max_connections, isScratch)  
```  
USERNAME: (string) あなたのユーザー名  
  
PASSWORD: (string) あなたのパスワード  
  
ProjectID: (int) あなたのプロジェクトのID ( https://scratch.mit.edu/projects/{projectid} ) この部分がプロジェクトIDです  
  
max_connections: (int) 最大同時送信数、この数の分、同時に変数を**変更**できます  
  
isScratch: (boolean or string) TrueならScratch、FalseならTurbowarp、URLを入力すると特定のサーバーに接続できます。  
### Get Cloud Variable 
```python
conn.get(var_NAME)  
```
var_NAME: **list** 取得するクラウド変数の名前（例: `["Sample1", "Sample2"]`）
戻り値: **list** 取得できなかった場合、Noneが返ります。 （例: `[200, None]`
#### 補足　クラウド変数の取得のみの場合には、最大接続数は0でもOKです
### Set Cloud Valiable
```python
conn.set(var_NAME, var_VALUE)
```
var_NAME: **list** 変更するクラウド変数の名前（例: `["Sample1", "Sample2"]`）
var_VALUE: **list** 変更する数値 (intまたはstr)（例: `["20", 1304]`）
## Sample
```python
import random  
import scratch_api.scratch_ws_api as scratch3 

conn = scratch3.login("yosshi---", "PASSWORD").connect(846708650, 2, True)
conn.send(["1", "2"], [random.randint(1, 10), random.randint(1, 10)])  
print(conn.get(["1","2"]))
```
ランダムに変数を変更するだけの単純なプログラムです

[こちらがそのプロジェクトです](https://scratch.mit.edu/projects/846708650)
