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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for disnake-2.7.2.tar.gz
Algorithm Hash digest
SHA256 a0788376f9b0b0d3b768f3b84e7a70b2d41cd8fc859977bc8c7db846dd45bdf3
MD5 02f9717243ce3b1036c76b5d4259b46c
BLAKE2b-256 17c33884b5df865d536ac3c68fe2c1c9222490dc18e7bd0530d46db7bd42ccbe

See more details on using hashes here.

File details

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

File metadata

  • Download URL: disnake-2.7.2-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.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 bed89e2019d9dc3306be9b288c724474da52500bd299616ff55a16905271a74d
MD5 e155491b6023b6e9b53964970f3bc00b
BLAKE2b-256 e9b2fa65576b239ba2319b3e5efc2ee7b721c41bdcbb9c08852b74a06698d7d2

See more details on using hashes here.

Supported by

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