<!-- SPDX-License-Identifier: MIT -->
[](https://disnake.dev/)
disnake
=======
<p align="center">
<img src="https://img.shields.io/github/actions/workflow/status/DisnakeDev/disnake/lint-test.yml?branch=master&style=flat-square"></img>
<a href="https://discord.gg/disnake"><img src="https://img.shields.io/discord/808030843078836254?style=flat-square&color=5865f2&logo=discord&logoColor=ffffff&label=discord" alt="Discord server invite" /></a>
<a href="https://pypi.org/project/disnake/"><img src="https://img.shields.io/pypi/v/disnake.svg?style=flat-square" alt="PyPI version info" /></a>
<a href="https://pypi.org/project/disnake/"><img src="https://img.shields.io/pypi/pyversions/disnake.svg?style=flat-square" alt="PyPI supported Python versions" /></a>
<a href="https://github.com/DisnakeDev/disnake/commits"><img src="https://img.shields.io/github/commit-activity/w/DisnakeDev/disnake.svg?style=flat-square" alt="Commit activity" /></a>
</p>
A modern, easy to use, feature-rich, and async-ready API wrapper for Discord written in Python.
Key Features
------------
- Proper rate limit handling.
- Type-safety measures.
- [FastAPI](https://fastapi.tiangolo.com/)-like slash command syntax.
<sup>The syntax and structure of `discord.py 2.0` is preserved.</sup>
Installing
----------
**Python 3.8 or higher is required.**
To install the library without full voice support, you can just run the
following command:
``` sh
# Linux/macOS
python3 -m pip install -U disnake
# Windows
py -3 -m pip install -U disnake
```
Installing `disnake` with full voice support requires you to replace `disnake` here, with `disnake[voice]`. To learn more about voice support (or installing the development version), please visit [this section of our guide](https://guide.disnake.dev/prerequisites/installing-disnake/).
(You can optionally install [PyNaCl](https://pypi.org/project/PyNaCl/) for voice support.)
Note that voice support on Linux requires installation of `libffi-dev` and `python-dev` packages, via your preferred package manager (e.g. `apt`, `dnf`, etc.) before running the following commands.
Versioning
----------
This project does **not** quite follow semantic versioning; for more details, see [version guarantees](https://docs.disnake.dev/en/latest/version_guarantees.html).
To be on the safe side and avoid unexpected breaking changes, pin the dependency to a minor version (e.g. `disnake==a.b.*` or `disnake~=a.b.c`) or an exact version (e.g. `disnake==a.b.c`).
Quick Example
-------------
### Slash Commands Example
``` py
import disnake
from disnake.ext import commands
bot = commands.InteractionBot(test_guilds=[12345])
@bot.slash_command()
async def ping(inter):
await inter.response.send_message("Pong!")
bot.run("BOT_TOKEN")
```
### Context Menus Example
``` py
import disnake
from disnake.ext import commands
bot = commands.InteractionBot(test_guilds=[12345])
@bot.user_command()
async def avatar(inter, user):
embed = disnake.Embed(title=str(user))
embed.set_image(url=user.display_avatar.url)
await inter.response.send_message(embed=embed)
bot.run("BOT_TOKEN")
```
### Prefix Commands Example
``` py
import disnake
from disnake.ext import commands
bot = commands.Bot(command_prefix=commands.when_mentioned)
@bot.command()
async def ping(ctx):
await ctx.send("Pong!")
bot.run("BOT_TOKEN")
```
You can find more examples in the [examples directory](./examples).
<br>
<p align="center">
<a href="https://docs.disnake.dev/">Documentation</a>
⁕
<a href="https://guide.disnake.dev/">Guide</a>
⁕
<a href="https://discord.gg/disnake">Discord Server</a>
⁕
<a href="https://discord.gg/discord-developers">Discord Developers</a>
</p>
<br>
Raw data
{
"_id": null,
"home_page": "",
"name": "disnake",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "disnake,discord,discord api",
"author": "Disnake Development",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/cd/3b/65032beb5045784dcd211d1bdea69ff723d8c002841ffa0ba67f7b426fec/disnake-2.9.1.tar.gz",
"platform": null,
"description": "<!-- SPDX-License-Identifier: MIT -->\n\n[](https://disnake.dev/)\n\ndisnake\n=======\n<p align=\"center\">\n <img src=\"https://img.shields.io/github/actions/workflow/status/DisnakeDev/disnake/lint-test.yml?branch=master&style=flat-square\"></img>\n <a href=\"https://discord.gg/disnake\"><img src=\"https://img.shields.io/discord/808030843078836254?style=flat-square&color=5865f2&logo=discord&logoColor=ffffff&label=discord\" alt=\"Discord server invite\" /></a>\n <a href=\"https://pypi.org/project/disnake/\"><img src=\"https://img.shields.io/pypi/v/disnake.svg?style=flat-square\" alt=\"PyPI version info\" /></a>\n <a href=\"https://pypi.org/project/disnake/\"><img src=\"https://img.shields.io/pypi/pyversions/disnake.svg?style=flat-square\" alt=\"PyPI supported Python versions\" /></a>\n <a href=\"https://github.com/DisnakeDev/disnake/commits\"><img src=\"https://img.shields.io/github/commit-activity/w/DisnakeDev/disnake.svg?style=flat-square\" alt=\"Commit activity\" /></a>\n</p>\n\nA modern, easy to use, feature-rich, and async-ready API wrapper for Discord written in Python.\n\nKey Features\n------------\n\n- Proper rate limit handling.\n- Type-safety measures.\n- [FastAPI](https://fastapi.tiangolo.com/)-like slash command syntax.\n\n<sup>The syntax and structure of `discord.py 2.0` is preserved.</sup>\n\nInstalling\n----------\n\n**Python 3.8 or higher is required.**\n\nTo install the library without full voice support, you can just run the\nfollowing command:\n\n``` sh\n# Linux/macOS\npython3 -m pip install -U disnake\n\n# Windows\npy -3 -m pip install -U disnake\n```\n\nInstalling `disnake` with full voice support requires you to replace `disnake` here, with `disnake[voice]`. To learn more about voice support (or installing the development version), please visit [this section of our guide](https://guide.disnake.dev/prerequisites/installing-disnake/).\n\n(You can optionally install [PyNaCl](https://pypi.org/project/PyNaCl/) for voice support.)\n\nNote that voice support on Linux requires installation of `libffi-dev` and `python-dev` packages, via your preferred package manager (e.g. `apt`, `dnf`, etc.) before running the following commands.\n\nVersioning\n----------\n\nThis project does **not** quite follow semantic versioning; for more details, see [version guarantees](https://docs.disnake.dev/en/latest/version_guarantees.html).\n\nTo be on the safe side and avoid unexpected breaking changes, pin the dependency to a minor version (e.g. `disnake==a.b.*` or `disnake~=a.b.c`) or an exact version (e.g. `disnake==a.b.c`).\n\nQuick Example\n-------------\n\n### Slash Commands Example\n\n``` py\nimport disnake\nfrom disnake.ext import commands\n\nbot = commands.InteractionBot(test_guilds=[12345])\n\n@bot.slash_command()\nasync def ping(inter):\n await inter.response.send_message(\"Pong!\")\n\nbot.run(\"BOT_TOKEN\")\n```\n\n### Context Menus Example\n\n``` py\nimport disnake\nfrom disnake.ext import commands\n\nbot = commands.InteractionBot(test_guilds=[12345])\n\n@bot.user_command()\nasync def avatar(inter, user):\n embed = disnake.Embed(title=str(user))\n embed.set_image(url=user.display_avatar.url)\n await inter.response.send_message(embed=embed)\n\nbot.run(\"BOT_TOKEN\")\n```\n\n### Prefix Commands Example\n\n``` py\nimport disnake\nfrom disnake.ext import commands\n\nbot = commands.Bot(command_prefix=commands.when_mentioned)\n\n@bot.command()\nasync def ping(ctx):\n await ctx.send(\"Pong!\")\n\nbot.run(\"BOT_TOKEN\")\n```\n\nYou can find more examples in the [examples directory](./examples).\n\n<br>\n<p align=\"center\">\n <a href=\"https://docs.disnake.dev/\">Documentation</a>\n \u2055\n <a href=\"https://guide.disnake.dev/\">Guide</a>\n \u2055\n <a href=\"https://discord.gg/disnake\">Discord Server</a>\n \u2055\n <a href=\"https://discord.gg/discord-developers\">Discord Developers</a>\n</p>\n<br>\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python wrapper for the Discord API",
"version": "2.9.1",
"project_urls": {
"Changelog": "https://docs.disnake.dev/page/whats_new.html",
"Documentation": "https://docs.disnake.dev/",
"Repository": "https://github.com/DisnakeDev/disnake"
},
"split_keywords": [
"disnake",
"discord",
"discord api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a8e1f495ebf88d3f6e955eced844329847be39346ae9b5c1ef254184da433f04",
"md5": "46e201c88229d794b22ca0b26bbc7fb5",
"sha256": "d2c772f4275ef3cd06775b32d3ffe97271d0df239f37880940a9ec73aa3739f6"
},
"downloads": -1,
"filename": "disnake-2.9.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "46e201c88229d794b22ca0b26bbc7fb5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 1069355,
"upload_time": "2023-10-30T20:37:58",
"upload_time_iso_8601": "2023-10-30T20:37:58.661305Z",
"url": "https://files.pythonhosted.org/packages/a8/e1/f495ebf88d3f6e955eced844329847be39346ae9b5c1ef254184da433f04/disnake-2.9.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cd3b65032beb5045784dcd211d1bdea69ff723d8c002841ffa0ba67f7b426fec",
"md5": "c6d9a38b5675be74a04554042b99a708",
"sha256": "b6b33ba95c9d220f64fb17413d0c0ffd89708dc30510e9900a1d9990b69b929f"
},
"downloads": -1,
"filename": "disnake-2.9.1.tar.gz",
"has_sig": false,
"md5_digest": "c6d9a38b5675be74a04554042b99a708",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 1019747,
"upload_time": "2023-10-30T20:38:03",
"upload_time_iso_8601": "2023-10-30T20:38:03.154404Z",
"url": "https://files.pythonhosted.org/packages/cd/3b/65032beb5045784dcd211d1bdea69ff723d8c002841ffa0ba67f7b426fec/disnake-2.9.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-30 20:38:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "DisnakeDev",
"github_project": "disnake",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "disnake"
}
JSON
