A Python wrapper for the Discord API
Project description
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-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:
# 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.
(You can optionally install 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.
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
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
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
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.
Documentation ⁕ Guide ⁕ Discord Server ⁕ Discord Developers
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file disnake-2.5.3.tar.gz
.
File metadata
- Download URL: disnake-2.5.3.tar.gz
- Upload date:
- Size: 934.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.9.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 80f780a9b6ccdbc4cea66cfd276c2e6a8860fb628da65896864ab3c7dd0669c7 |
|
MD5 | c453ea76cc6777605a6e5b6619d9a1c0 |
|
BLAKE2b-256 | 00e070c9fcc9aa38c03965c1f6761d34bee42517423f64eaa22cac2c84fd9538 |
File details
Details for the file disnake-2.5.3-py3-none-any.whl
.
File metadata
- Download URL: disnake-2.5.3-py3-none-any.whl
- Upload date:
- Size: 1.0 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.9.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ebe1a3b4a991bcbafbfe974a55d88247a04026a62e709256ca2e7c046b570641 |
|
MD5 | 69bdfa22c0ddcfe94e22a37907880e72 |
|
BLAKE2b-256 | 8e371edfc6bfe37d99874b15c817328af7cdd922aeaa0a701ca15ebb923f7c28 |