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

Uploaded Source

Built Distribution

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

discord.py-2.3.0-py3-none-any.whl (1.1 MB view details)

Uploaded Python 3

File details

Details for the file discord.py-2.3.0.tar.gz.

File metadata

  • Download URL: discord.py-2.3.0.tar.gz
  • Upload date:
  • Size: 978.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for discord.py-2.3.0.tar.gz
Algorithm Hash digest
SHA256 c71066a30f037d069218e59092505c3e8945fd175e396a80748056d989756806
MD5 50545783f5a85a2956f251b2c12d30bd
BLAKE2b-256 c5e524ff387ee96bb6ccfa6ef6b8e2e6a829389e2b1231210dad42744104c446

See more details on using hashes here.

File details

Details for the file discord.py-2.3.0-py3-none-any.whl.

File metadata

  • Download URL: discord.py-2.3.0-py3-none-any.whl
  • Upload date:
  • Size: 1.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for discord.py-2.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3e9498967822ad4499f8f72deb9173f942d9827d92b6e4e4e7732d24f78f300c
MD5 4e9d564a9baa39a154dd08781f24d6f4
BLAKE2b-256 d3d697c2b62b0c1bbb730c982ad7618f6ddb569d1ac71ed9a62bd9d52df66da2

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