# DiscWrappy
A Python wrapper for the Discord bot API
# Docs
### **Initialization:**
```py
import discwrappy
client = discwrappy.Client()
...
client.run(TOKEN)
```
### **Functions:**
**`@Client.on() - decorator`:**
* **Params:**
* **[event_type](./event_types.md) -** The type of event you're waiting for
* **Function:**
* Creates a "listener" which waits for the given event and triggers your function
> ```py
> @client.on("READY")
> def onReady(ready):
> print("bot online")
> ```
**`Message.send() - function`:**
* **Params:**
* **message (dict) -** The Mesage you want to send
* **Function:**
* Sends the given dict to the message's channel
> ```py
> @client.on("MESSAGE_CREATE")
> def printMessageContent(message):
> message.send({ "content": message.content})
> ```
**`discwrappy.Message() - class`:**
* **Params:**
* **message (dict) -** The default Discord message dict
* **Function:**
* Turns given message dict into a "proper object" (keys can be access with dot notation), converts numeric ids to ints, and gives the message send functions
**`discwrappy.User() - class`:**
* **Params:**
* **user (dict) -** The default Discord user dict
* **Function:**
* Turns given user dict into a "proper object" (keys can be access with dot notation) and converts numeric ids to ints
**`discwrappy.GuildMember() - class`:**
* **Params:**
* **user (dict) -** The default Discord guild member dict
* **Function:**
* Turns given guild member dict into a "proper object" (keys can be access with dot notation)
Raw data
{
"_id": null,
"home_page": "https://github.com/JeffTheModder/DiscWrappy",
"name": "discwrappy",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "Discord,API,wrapper,python,library",
"author": "Jeff Morris",
"author_email": "jeffreyjr.morris@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f9/4d/26e00c2a9206e2c7a9e81ba2f2c014f11438724e7da3f812a25e63b4e38c/discwrappy-0.5.tar.gz",
"platform": null,
"description": "# DiscWrappy\nA Python wrapper for the Discord bot API\n\n# Docs\n### **Initialization:**\n```py\nimport discwrappy\n\nclient = discwrappy.Client()\n\n...\n\nclient.run(TOKEN)\n```\n\n### **Functions:**\n**`@Client.on() - decorator`:**\n * **Params:**\n * **[event_type](./event_types.md) -** The type of event you're waiting for\n * **Function:**\n * Creates a \"listener\" which waits for the given event and triggers your function\n> ```py\n> @client.on(\"READY\")\n> def onReady(ready):\n> print(\"bot online\")\n> ```\n\n**`Message.send() - function`:**\n * **Params:**\n * **message (dict) -** The Mesage you want to send\n * **Function:**\n * Sends the given dict to the message's channel\n> ```py\n> @client.on(\"MESSAGE_CREATE\")\n> def printMessageContent(message):\n> message.send({ \"content\": message.content})\n> ```\n\n**`discwrappy.Message() - class`:**\n * **Params:**\n * **message (dict) -** The default Discord message dict\n * **Function:**\n * Turns given message dict into a \"proper object\" (keys can be access with dot notation), converts numeric ids to ints, and gives the message send functions\n\n**`discwrappy.User() - class`:**\n * **Params:**\n * **user (dict) -** The default Discord user dict\n * **Function:**\n * Turns given user dict into a \"proper object\" (keys can be access with dot notation) and converts numeric ids to ints\n\n**`discwrappy.GuildMember() - class`:**\n * **Params:**\n * **user (dict) -** The default Discord guild member dict\n * **Function:**\n * Turns given guild member dict into a \"proper object\" (keys can be access with dot notation)\n",
"bugtrack_url": null,
"license": "",
"summary": "A Python wrapper for the Discord API",
"version": "0.5",
"split_keywords": [
"discord",
"api",
"wrapper",
"python",
"library"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f94d26e00c2a9206e2c7a9e81ba2f2c014f11438724e7da3f812a25e63b4e38c",
"md5": "f018998e33efd0a2662412920b02a30e",
"sha256": "be522261350b21b54916b0f77e122a57b3d130d8d49a681b1ff675e6ea290692"
},
"downloads": -1,
"filename": "discwrappy-0.5.tar.gz",
"has_sig": false,
"md5_digest": "f018998e33efd0a2662412920b02a30e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 17031,
"upload_time": "2023-03-25T21:03:48",
"upload_time_iso_8601": "2023-03-25T21:03:48.406556Z",
"url": "https://files.pythonhosted.org/packages/f9/4d/26e00c2a9206e2c7a9e81ba2f2c014f11438724e7da3f812a25e63b4e38c/discwrappy-0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-25 21:03:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "JeffTheModder",
"github_project": "DiscWrappy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "discwrappy"
}
JSON
