Skip to main content

A Python wrapper for the Discord API

Project description

Discord server invite PyPI version info PyPI supported Python versions

A modern, easy to use, feature-rich, and async ready API wrapper for Discord written in Python.

Key Features

  • Modern Pythonic API using async and await.

  • 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 discord.py

# Windows
py -3 -m pip install -U discord.py

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

# Linux/macOS
python3 -m pip install -U "discord.py[voice]"

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

To install the development version, do the following:

$ git clone https://github.com/Rapptz/discord.py
$ cd discord.py
$ python3 -m pip install -U .[voice]

Optional Packages

Please note that when installing voice support on Linux, 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.8-dev for Python 3.8)

Quick Example

import discord

class MyClient(discord.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')

intents = discord.Intents.default()
intents.message_content = True
client = MyClient(intents=intents)
client.run('token')

Bot Example

import discord
from discord.ext import commands

intents = discord.Intents.default()
intents.message_content = True
bot = commands.Bot(command_prefix='>', intents=intents)

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

bot.run('token')

You can find more examples in the examples directory.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

discord_py-2.6.3.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

discord_py-2.6.3-py3-none-any.whl (1.2 MB view details)

Uploaded Python 3

File details

Details for the file discord_py-2.6.3.tar.gz.

File metadata

  • Download URL: discord_py-2.6.3.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.1

File hashes

Hashes for discord_py-2.6.3.tar.gz
Algorithm Hash digest
SHA256 92bb3ef9dbe08525803be1e357bc0191f59ae16956690fc96c34f40bcd02c649
MD5 dff25bc60f320f1bf1d0f6bc50c9619e
BLAKE2b-256 6f00ec765ba7d5e16dfc070953a992379c8de8489164f9e006f7ebd8870b426f

See more details on using hashes here.

File details

Details for the file discord_py-2.6.3-py3-none-any.whl.

File metadata

  • Download URL: discord_py-2.6.3-py3-none-any.whl
  • Upload date:
  • Size: 1.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.1

File hashes

Hashes for discord_py-2.6.3-py3-none-any.whl
Algorithm Hash digest
SHA256 69835269d73d9889a2f0efff4c91264a18998db0fdc4295a3c886fe9196dea4e
MD5 0fc4ce02294031e8f26407e403f3954e
BLAKE2b-256 fd4e05fcecd452bde37fba8e9545c318099cbb8bad7f496b6d9322fa2b88f92f

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