Metadata-Version: 2.1
Name: cloudlink
Version: 0.1.3.2
Summary: Server-side code for a powerful Scratch 3.0 websocket extension.
Home-page: https://github.com/MikeDev101/cloudlink
Author: MikeDev101
Author-email: mikierules109@gmail.com
License: 0BSD
Keywords: scratch,cloud variable,cloud variables,cloudlink,scratch3
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved
Classifier: License :: Freely Distributable
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE

### [Discussion Forum](https://scratch.mit.edu/discuss/topic/398473)
### [HackMD Documentation](https://hackmd.io/G9q1kPqvQT6NrPobjjxSgg)

CloudLink is a high-speed, reliable, and custom websocket extension for Scratch 3.0, with server code that runs on Python.
It permits cross-project (as well as cross-program) cloud variables.
It also enables full-duplex networking and limitless possibilities for Scratch 3.0 projects.

Example usage:
```
from cloudlink import CloudLink

cl = CloudLink()
cl.host(3000) # Hosts CloudLink in Server Mode on ws://localhost:3000/
```

Please report any bugs you find to the official [GitHub repository](https://github.com/MikeDev101/cloudlink/issues) or on
my [Scratch profile.](https://scratch.mit.edu/users/MikeDEV/)


# Scratch Extension
You can view the client-side extension using one of the following modded Scratch editors:
* [TurboWarp](https://turbowarp.org/editor?extension=https://mikedev101.github.io/cloudlink/B3-0.js)
* [SheepTester's E羊icques](https://sheeptester.github.io/scratch-gui/?url=https://mikedev101.github.io/cloudlink/B3-0.js)
* [Ogadaki's Adacraft (Manual load required)](https://adacraft.org/studio/)

# Installing CloudLink
## Method 1: using pip3 (This is WIP and may not work)
```pip3 install cloudlink```

## Method 2: Directly downloading cloudlink.py
Simply download the [source code](https://github.com/MikeDev101/cloudlink/archive/refs/heads/master.zip), extract cloudlink.py, and import it as shown above. However, the following dependencies are required in order to take advantage of full functionality:
* websocket-server ```pip3 install websocket-server```
* websocket-client ```pip3 install websocket-client```


