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.7.0.tar.gz (973.9 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.7.0-py3-none-any.whl (1.0 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: disnake-2.7.0.tar.gz
  • Upload date:
  • Size: 973.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.0

File hashes

Hashes for disnake-2.7.0.tar.gz
Algorithm Hash digest
SHA256 414a36c998826df2795aac946f867f3b13b6f15db456913425faa50b311f12d6
MD5 71c69d8b6a709f3841791ddb855bb16e
BLAKE2b-256 0535f82ebb534b01e4d392922b7ca5666edfc70657f567282119bd63d4748c45

See more details on using hashes here.

File details

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

File metadata

  • Download URL: disnake-2.7.0-py3-none-any.whl
  • Upload date:
  • Size: 1.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.0

File hashes

Hashes for disnake-2.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c13de5fcc6dc5442e6f1f5c62e7f24038ecbe7d629c0b3c5506bf1b3c706c26a
MD5 78618c4ebdaa5afa97dc2e07b422bdb4
BLAKE2b-256 355dfc84bd2e28da9fdcd49c7e6af568d4c4c17f4eea8f9379cb9e057f68bb59

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