# Scrathon
Scrathon is a Python package designed to interact with the Scrathon platform to allow for purchases in your projects.
## Installation
You can install Scrathon via pip: ```pip install scrathon-payments```
## Usage with [Scratchattach](https://github.com/TimMcCool/scratchattach)
To use Scrathon, you need to instantiate the `Scrathon` class with a valid username and scratchattach cloud requests client. These will be used to authenticate and perform transactions on the Scrathon platform.
```python
from os import system
system("pip install scratchattach --upgrade")
system("pip install scrathon-payments --upgrade")
import scratchattach as scratch3
from ScrathonPayments import Scrathon
session = scratch3.login("username of any account (can be an alt with new scratcher)", "password of the account")
conn = session.connect_cloud("YOUR PROJECT ID")
client = scratch3.CloudRequests(conn)
ScrathonPayments = Scrathon("username of account to receive coins", client)
client.run()
#Guess what? That's it!
```
Check out the example project here: https://scratch.mit.edu/projects/996449477/
## Methods
```Scrathon() ``` *Initiates a project connection to Scrathon services.*
| Parameter | Type | Description |
| :-------- | :------- | :------------------------- |
| `User` | `str` | **Required**. User to receive funds from purchases |
| `Client` | `scratchattach.CloudRequests` | **Required**. Scratchattach Client |
```
Raw data
{
"_id": null,
"home_page": "https://github.com/Ryan-shamu-YT/ScrathonPayments",
"name": "scrathon-payments",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "scratch, api",
"author": "Ryan_shamu",
"author_email": "Ryanshamu418@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ba/68/078cbf72ed5966b1e975adf142ffb7b039bd1a1edbf50737f89154913fa6/scrathon_payments-0.2.8.tar.gz",
"platform": null,
"description": "# Scrathon\n\nScrathon is a Python package designed to interact with the Scrathon platform to allow for purchases in your projects.\n\n## Installation\n\nYou can install Scrathon via pip: ```pip install scrathon-payments```\n\n## Usage with [Scratchattach](https://github.com/TimMcCool/scratchattach)\n\nTo use Scrathon, you need to instantiate the `Scrathon` class with a valid username and scratchattach cloud requests client. These will be used to authenticate and perform transactions on the Scrathon platform.\n\n\n```python\nfrom os import system\nsystem(\"pip install scratchattach --upgrade\")\nsystem(\"pip install scrathon-payments --upgrade\")\nimport scratchattach as scratch3\nfrom ScrathonPayments import Scrathon\n\nsession = scratch3.login(\"username of any account (can be an alt with new scratcher)\", \"password of the account\")\n\nconn = session.connect_cloud(\"YOUR PROJECT ID\")\n\nclient = scratch3.CloudRequests(conn)\n\nScrathonPayments = Scrathon(\"username of account to receive coins\", client)\n\nclient.run()\n\n#Guess what? That's it!\n```\nCheck out the example project here: https://scratch.mit.edu/projects/996449477/\n\n## Methods\n```Scrathon() ``` *Initiates a project connection to Scrathon services.*\n\n| Parameter | Type | Description |\n| :-------- | :------- | :------------------------- |\n| `User` | `str` | **Required**. User to receive funds from purchases |\n| `Client` | `scratchattach.CloudRequests` | **Required**. Scratchattach Client |\n\n\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "API Wrapper for ScrathonPayments",
"version": "0.2.8",
"project_urls": {
"Homepage": "https://github.com/Ryan-shamu-YT/ScrathonPayments"
},
"split_keywords": [
"scratch",
" api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f56ccad5cdb7fd5376d6d95fb34c0c78146c12cf4e1f20fb8dccf3447d00aeb8",
"md5": "21900b1a491af240ff33fb491b72ed98",
"sha256": "39fba6b3a85826425c47a798291bc88c5bf30eb8c4f786e4cce3a4b91094f22b"
},
"downloads": -1,
"filename": "scrathon_payments-0.2.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "21900b1a491af240ff33fb491b72ed98",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 3612,
"upload_time": "2024-06-21T06:22:09",
"upload_time_iso_8601": "2024-06-21T06:22:09.793268Z",
"url": "https://files.pythonhosted.org/packages/f5/6c/cad5cdb7fd5376d6d95fb34c0c78146c12cf4e1f20fb8dccf3447d00aeb8/scrathon_payments-0.2.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ba68078cbf72ed5966b1e975adf142ffb7b039bd1a1edbf50737f89154913fa6",
"md5": "cd4bb862c83bcc4b88cd267ccc1450ae",
"sha256": "93e427b1f47f475ef3d758ade681d011f287c97b40c67579086fe80823973308"
},
"downloads": -1,
"filename": "scrathon_payments-0.2.8.tar.gz",
"has_sig": false,
"md5_digest": "cd4bb862c83bcc4b88cd267ccc1450ae",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 3298,
"upload_time": "2024-06-21T06:22:11",
"upload_time_iso_8601": "2024-06-21T06:22:11.626608Z",
"url": "https://files.pythonhosted.org/packages/ba/68/078cbf72ed5966b1e975adf142ffb7b039bd1a1edbf50737f89154913fa6/scrathon_payments-0.2.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-21 06:22:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Ryan-shamu-YT",
"github_project": "ScrathonPayments",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "scrathon-payments"
}
JSON
