Skip to main content

A Python wrapper for the Discord API

Project description

Disnake Banner

disnake

Discord server invite PyPI version info PyPI supported Python versions Commit activity

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.


DocumentationGuideDiscord ServerDiscord Developers


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

disnake-2.5.0.tar.gz (933.7 kB view details)

Uploaded Source

Built Distribution

disnake-2.5.0-py3-none-any.whl (1.0 MB view details)

Uploaded Python 3

File details

Details for the file disnake-2.5.0.tar.gz.

File metadata

  • Download URL: disnake-2.5.0.tar.gz
  • Upload date:
  • Size: 933.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.12

File hashes

Hashes for disnake-2.5.0.tar.gz
Algorithm Hash digest
SHA256 116722e0a69549519cd97526bec54a33530d7c7059a21917b9c66073b2221fcb
MD5 e3a782756a5944e1f001c97133c58032
BLAKE2b-256 96ddb5fc58f1280117e545007f604296e14a9b17a5921f8743dd7db379307fca

See more details on using hashes here.

File details

Details for the file disnake-2.5.0-py3-none-any.whl.

File metadata

  • Download URL: disnake-2.5.0-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

Hashes for disnake-2.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8f64bfda301d4113bc05d2728448b87711e9d962d4428741c55b3018372c4753
MD5 445860daf1655f95e75ff7e3d06ed4aa
BLAKE2b-256 afac06dfc6994080189ecdc128cb9742e7a61423bc8d2ed4512a6388a320e4cb

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page