| Name | discordwrap JSON |
| Version |
0.9.0
JSON |
| download |
| home_page | https://discordwrap.brunuslabs.com/ |
| Summary | A simple, intuitive wrapper around the underbelly of the discord API. This library is meant to be used with the discord docs. Responses from methods in the library will return JSON just as discords api details. |
| upload_time | 2023-04-18 02:36:23 |
| maintainer | |
| docs_url | None |
| author | josh |
| requires_python | >=3.10,<4.0 |
| license | MIT |
| keywords |
discord
api
lightweight
asyncio
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# DiscordWrap
A simple, intuitive wrapper around the underbelly of the discord API.
This library is meant to be used with the discord docs. Responses from methods in the library will return
JSON just as discords api details.
# Installation
```sh
pip install discordwrap
```
## Example
```py
from discordwrap import Auth, channel
Auth.TOKEN = 'your token'
# your channel
channel = 111111111111111
channel.create_message(channel, json={
'content': 'Hello world!'
})
```
## Docs
Find offical docs [here](https://discordwrap.brunuslabs.com)!
## Motivation
Using any API can be daunting. Using a library with poor documentation can be even worse.
The goal of this library is to not need any documentation, other than discords.
This is why users are encouraged to use raw json for bodies, and responses of requests.
So what does this library do? The most daunting part. The rate limiting, and overall python
function creation, and async handling. Requests under the hood are asynchronous, however to the end
user of the library, they are not. This lets consumers freely use our library without needing to
worry about buckets, rate limits, or any other messy details, and focus on building their product.
Rate limiting blocks only when needed, and makes sure to only keep one thread alive. There is no class instantiation needed once the
Auth token is set.
This library does NOT (yet) implement the discord gateway, as there are plenty of other libraries that are much better for bot building.
This library is targeted at developers that are not building an interactive bot, but need the ability to use the discord api in another project.
## Use cases
- Ping a discord server when a script is done running
- Get information about a discord channel for integration with another service
- More to come!
Raw data
{
"_id": null,
"home_page": "https://discordwrap.brunuslabs.com/",
"name": "discordwrap",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "Discord,API,Lightweight,AsyncIO",
"author": "josh",
"author_email": "josh@brunuslabs.com",
"download_url": "https://files.pythonhosted.org/packages/b8/f8/a490bc13276ce126ef15e7a5c84dd404d574dcad9ff96b36bb61efd293bb/discordwrap-0.9.0.tar.gz",
"platform": null,
"description": "# DiscordWrap\nA simple, intuitive wrapper around the underbelly of the discord API.\nThis library is meant to be used with the discord docs. Responses from methods in the library will return\nJSON just as discords api details.\n\n# Installation\n```sh\npip install discordwrap\n```\n\n## Example\n```py\nfrom discordwrap import Auth, channel\n\nAuth.TOKEN = 'your token'\n\n# your channel\nchannel = 111111111111111\n\nchannel.create_message(channel, json={\n 'content': 'Hello world!'\n})\n```\n\n## Docs\n\nFind offical docs [here](https://discordwrap.brunuslabs.com)!\n\n## Motivation\nUsing any API can be daunting. Using a library with poor documentation can be even worse. \nThe goal of this library is to not need any documentation, other than discords.\nThis is why users are encouraged to use raw json for bodies, and responses of requests.\n\nSo what does this library do? The most daunting part. The rate limiting, and overall python\nfunction creation, and async handling. Requests under the hood are asynchronous, however to the end\nuser of the library, they are not. This lets consumers freely use our library without needing to\nworry about buckets, rate limits, or any other messy details, and focus on building their product.\n\nRate limiting blocks only when needed, and makes sure to only keep one thread alive. There is no class instantiation needed once the\nAuth token is set.\n\nThis library does NOT (yet) implement the discord gateway, as there are plenty of other libraries that are much better for bot building.\nThis library is targeted at developers that are not building an interactive bot, but need the ability to use the discord api in another project.\n\n## Use cases\n\n- Ping a discord server when a script is done running\n- Get information about a discord channel for integration with another service\n- More to come!\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A simple, intuitive wrapper around the underbelly of the discord API. This library is meant to be used with the discord docs. Responses from methods in the library will return JSON just as discords api details.",
"version": "0.9.0",
"split_keywords": [
"discord",
"api",
"lightweight",
"asyncio"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eb04f4a4337064e5d30153be91dac64d8af4e27e80d0a79acdda04f77290fc3a",
"md5": "3bb5a652f4ee2478af93fa515cb5aa40",
"sha256": "636995c4a2c8f979893763424aa57988fe38f8935d5ee0121a33eea1ea407b61"
},
"downloads": -1,
"filename": "discordwrap-0.9.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3bb5a652f4ee2478af93fa515cb5aa40",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 6824,
"upload_time": "2023-04-18T02:36:21",
"upload_time_iso_8601": "2023-04-18T02:36:21.143538Z",
"url": "https://files.pythonhosted.org/packages/eb/04/f4a4337064e5d30153be91dac64d8af4e27e80d0a79acdda04f77290fc3a/discordwrap-0.9.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b8f8a490bc13276ce126ef15e7a5c84dd404d574dcad9ff96b36bb61efd293bb",
"md5": "4ae3b124b6a80adc1f5e9f067c2493c9",
"sha256": "1329bbe874791f8ce13b5d6d7eb8f8d499026ad74e8e240c9266421ea01ed64e"
},
"downloads": -1,
"filename": "discordwrap-0.9.0.tar.gz",
"has_sig": false,
"md5_digest": "4ae3b124b6a80adc1f5e9f067c2493c9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 5123,
"upload_time": "2023-04-18T02:36:23",
"upload_time_iso_8601": "2023-04-18T02:36:23.112032Z",
"url": "https://files.pythonhosted.org/packages/b8/f8/a490bc13276ce126ef15e7a5c84dd404d574dcad9ff96b36bb61efd293bb/discordwrap-0.9.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-18 02:36:23",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "discordwrap"
}
