Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/DisnakeDev/disnake
An API wrapper for Discord written in Python.
https://github.com/DisnakeDev/disnake
application-commands bot context-menus discord discord-api discord-bot discord-py hacktoberfest interactions message-components python slash-commands
Last synced: about 1 month ago
JSON representation
An API wrapper for Discord written in Python.
- Host: GitHub
- URL: https://github.com/DisnakeDev/disnake
- Owner: DisnakeDev
- License: mit
- Created: 2021-08-28T10:24:13.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-05-19T15:39:01.000Z (4 months ago)
- Last Synced: 2024-05-20T13:27:56.733Z (4 months ago)
- Topics: application-commands, bot, context-menus, discord, discord-api, discord-bot, discord-py, hacktoberfest, interactions, message-components, python, slash-commands
- Language: Python
- Homepage: https://docs.disnake.dev
- Size: 21.2 MB
- Stars: 701
- Watchers: 18
- Forks: 135
- Open Issues: 94
-
Metadata Files:
- Readme: README.md
- Changelog: changelog/1014.feature.rst
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- discord-api-libs - disnake - An API wrapper for Discord written in Python. (Libraries / Python)
- awesome-discordpy - disnake - A modern, easy to use, feature-rich, and async-ready API wrapper for Discord written in Python. (Forks and Wrappers / Miscellaneous)
- awesome-discord - disnake
- awesome-discord - disnake - Python (💻 API Libraries)
README
[](https://disnake.dev/)
disnake
=======
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.
The syntax and structure of `discord.py 2.0` is preserved.
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](https://github.com/DisnakeDev/disnake/tree/master/examples).
Documentation
⁕
Guide
⁕
Discord Server
⁕
Discord Developers