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

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.4.2.tar.gz (633.9 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.4.2-py3-none-any.whl (692.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: discord.py-1.4.2.tar.gz
  • Upload date:
  • Size: 633.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.42.0 CPython/3.7.3

File hashes

Hashes for discord.py-1.4.2.tar.gz
Algorithm Hash digest
SHA256 a79901342458f0750b9d7edb0c0de5a125b213f34c5d75331866386ee61a5a61
MD5 b1d7dac190bcb8ebfec7636cdafb8518
BLAKE2b-256 46939c7196fde7c72c04dd225a33fd29a6d71fb9d861be9c26fac6506440f503

See more details on using hashes here.

File details

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

File metadata

  • Download URL: discord.py-1.4.2-py3-none-any.whl
  • Upload date:
  • Size: 692.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.42.0 CPython/3.7.3

File hashes

Hashes for discord.py-1.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 038cd80cb50605b76a08c9fea27d8c13d855f923c81a64bb797ef4081fd9ded5
MD5 2708722598ae065c76863840f4c86404
BLAKE2b-256 4851dde7d4c1ceab2123d2861d145ae4772e62c4e5775ef1a4b742c09743e3c1

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