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.

About disnake

All the contributors and developers, associated with disnake, are trying their best to add new features to the library as soon as possible. We strive to revive the greatest Python wrapper for Discord API and keep it up to date.

Key Features

  • Modern Pythonic API using async and await.

  • Added features for ease of coding

  • Proper rate limit handling.

  • Optimised in both speed and memory.

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

Otherwise to get voice support you should run the following command:

# Linux/macOS
python3 -m pip install -U "disnake[voice]"

# Windows
py -3 -m pip install -U disnake[voice]

To install the development version, do the following:

$ git clone https://github.com/EQUENOS/disnake
$ cd disnake
$ python3 -m pip install -U .[voice]

Optional Packages

Please note that on Linux installing voice you must install the following packages via your favourite package manager (e.g. apt, dnf, etc) before running the above commands:

  • libffi-dev (or libffi-devel on some systems)

  • python-dev (e.g. python3.6-dev for Python 3.6)

Quick Example

import disnake

class MyClient(disnake.Client):
    async def on_ready(self):
        print('Logged on as', self.user)

    async def on_message(self, message):
        # don't respond to ourselves
        if message.author == self.user:
            return

        if message.content == 'ping':
            await message.channel.send('pong')

client = MyClient()
client.run('token')

Bot Example

import disnake
from disnake.ext import commands

bot = commands.Bot(command_prefix='>')

@bot.command()
async def ping(ctx):
    await ctx.send('pong')

bot.run('token')

Slash Commands Example

import disnake
from disnake.ext import commands

bot = commands.Bot(command_prefix='>', test_guilds=[12345])

@bot.slash_command()
async def ping(inter):
    await inter.response.send_message('pong')

bot.run('token')

Context Menus Example

import disnake
from disnake.ext import commands

bot = commands.Bot(command_prefix='>', test_guilds=[12345])

@bot.user_command()
async def avatar(inter):
    embed = disnake.Embed(title=str(inter.target))
    embed.set_image(url=inter.target.avatar.url)
    await inter.response.send_message(embed=embed)

bot.run('token')

You can find more examples in the examples directory.

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

Uploaded Source

Built Distribution

disnake-2.2.0-py3-none-any.whl (973.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: disnake-2.2.0.tar.gz
  • Upload date:
  • Size: 870.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.6

File hashes

Hashes for disnake-2.2.0.tar.gz
Algorithm Hash digest
SHA256 79ce0042e07ef75151cfcabc05c9c1a6be93a6020aa43896531b24c22a59cb8a
MD5 734f8f7bd5db6572e96b6746ebdc85c9
BLAKE2b-256 79a18ad4c5bc0661538ce9be0487d9dc0b0d6e332ed021214691adc4770f56e2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: disnake-2.2.0-py3-none-any.whl
  • Upload date:
  • Size: 973.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.6

File hashes

Hashes for disnake-2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b911e0fa1991d1e9f0a2f7bbeb9fd7c3d5e31c6b1b3da4a0f08b1f6330375b00
MD5 ac0029608ebaaca872f9d59409e84a0d
BLAKE2b-256 36f474e595e04d973bd70ef5c4b68c9e8d334245fba35b738e41198e577a3f65

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