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

This version

2.5.2

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.5.2.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: discord_py-2.5.2.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.5.2.tar.gz
Algorithm Hash digest
SHA256 01cd362023bfea1a4a1d43f5280b5ef00cad2c7eba80098909f98bf28e578524
MD5 ae3bc30f45e4a63713e9cbd2ff5b36d1
BLAKE2b-256 7fdd5817c7af5e614e45cdf38cbf6c3f4597590c442822a648121a34dee7fa0f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: discord_py-2.5.2-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.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 81f23a17c50509ffebe0668441cb80c139e74da5115305f70e27ce821361295a
MD5 ad7d2c5d4a9c441bc8a2da3050adeae3
BLAKE2b-256 57a8dc908a0fe4cd7e3950c9fa6906f7bf2e5d92d36b432f84897185e1b77138

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