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


Download files

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

Source Distribution

python-discord-1.7.3.tar.gz (733.7 kB view details)

Uploaded Source

Built Distribution

python_discord-1.7.3-py3-none-any.whl (789.2 kB view details)

Uploaded Python 3

File details

Details for the file python-discord-1.7.3.tar.gz.

File metadata

  • Download URL: python-discord-1.7.3.tar.gz
  • Upload date:
  • Size: 733.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.0 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.9

File hashes

Hashes for python-discord-1.7.3.tar.gz
Algorithm Hash digest
SHA256 a091ebf2c84f5b333c72042e9b78897c7733e27b26aa763e72388e00f224f017
MD5 4bfff8ad5336a0595da45f368d5ef406
BLAKE2b-256 d23036713d306258abe0f1409ecd066c976d3e8869c147e71a93b102bd163c8b

See more details on using hashes here.

File details

Details for the file python_discord-1.7.3-py3-none-any.whl.

File metadata

  • Download URL: python_discord-1.7.3-py3-none-any.whl
  • Upload date:
  • Size: 789.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.0 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.9

File hashes

Hashes for python_discord-1.7.3-py3-none-any.whl
Algorithm Hash digest
SHA256 5a125e93caf8e982b4cbff28b232f7d50480b1116428f25b71e33211ddea5237
MD5 62c89e4a936d8b83613746d11c186408
BLAKE2b-256 5219787dea79dc2ad5d0d2259d28c459a4c3901bfc743fd1947d50e1a2fe8f41

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page