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.

  • 100% coverage of the supported Discord API.

  • Optimised in both speed and memory.

Installing

Python 3.5.3 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

  • PyNaCl (for voice support)

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 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')

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

Bot Example

import discord
from discord.ext import commands

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

@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

1.7.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-1.7.2.tar.gz (731.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-1.7.2-py3-none-any.whl (786.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: discord.py-1.7.2.tar.gz
  • Upload date:
  • Size: 731.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.1

File hashes

Hashes for discord.py-1.7.2.tar.gz
Algorithm Hash digest
SHA256 114e76cd27362fb919abf7f001a2dbdc77c9a67cff74ed6a89aecd6582ee298e
MD5 1ce2464a3330a8f46a1f5719470a17ac
BLAKE2b-256 3426bb2a3daa3975c36d996bfb6279ed074a5d931cd056421d4563cd7b326d6b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: discord.py-1.7.2-py3-none-any.whl
  • Upload date:
  • Size: 786.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.1

File hashes

Hashes for discord.py-1.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f179db299c949a8cf0a12c1b1b94d0da9a18e088857154d93ae5ab1d807ec61d
MD5 7619267389c911c0b57669033839f504
BLAKE2b-256 25b8431808c895bb3a5ae24cfafc990c5fde0c4bbe07433cce29cd1f72bfb8d1

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