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.6.0.tar.gz (962.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for disnake-2.6.0.tar.gz
Algorithm Hash digest
SHA256 c6082b6ee57ee4d60ee8e9d1221110a384b26fa83808bede8a718ebf13cca3eb
MD5 14996651e58a715b014ae34c97260bed
BLAKE2b-256 8a4f240f3953288989f02d1ad0afc1325c043f2f5d62ca25e6d6d296a4f435b6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: disnake-2.6.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.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d50c8aa7eac22bf46dd3ce1735225c7f140399343d641ffa968af5b6674c4c29
MD5 cc78a79fbb4c5cce2b91c0a67ae59042
BLAKE2b-256 9cfcdf9c84e02c019b70d879dda1ba0b1c6794e3f933ddc2b214c7f47bd79d58

See more details on using hashes here.

Supported by

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