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.

Why fork discord.py?

The development of discord.py library has been ceased by its core (and sole) maintainer - Danny. Please read Danny’s gist for the full write-up on how we got to this point. Thank you, Danny. Thank you for all the amazing work you’ve done for this community.

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 redcord.py

# Windows
py -3 -m pip install -U redcord.py

Otherwise to get voice support you should run the following command:

# Linux/macOS
python3 -m pip install -U "redcord.py[voice]"

# Windows
py -3 -m pip install -U redcord.py[voice]

To install the development version, do the following:

$ git clone https://github.com/Cog-Creators/redcord.py
$ cd redcord.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

redcord.py-1.7.3.tar.gz (731.4 kB view details)

Uploaded Source

Built Distribution

redcord.py-1.7.3-py3-none-any.whl (786.9 kB view details)

Uploaded Python 3

File details

Details for the file redcord.py-1.7.3.tar.gz.

File metadata

  • Download URL: redcord.py-1.7.3.tar.gz
  • Upload date:
  • Size: 731.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.8.10

File hashes

Hashes for redcord.py-1.7.3.tar.gz
Algorithm Hash digest
SHA256 53e7c7f014c475abf6e54176511ca99159e9ac91fe06b2315a0fdfd96e0a54f7
MD5 8b78703cbf1c79a4a3ef7a1363988195
BLAKE2b-256 89578bbbfd321715d82506350cd4fda0916264cd99cf138ca61c446174bc5d69

See more details on using hashes here.

File details

Details for the file redcord.py-1.7.3-py3-none-any.whl.

File metadata

  • Download URL: redcord.py-1.7.3-py3-none-any.whl
  • Upload date:
  • Size: 786.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.8.10

File hashes

Hashes for redcord.py-1.7.3-py3-none-any.whl
Algorithm Hash digest
SHA256 c36c4b44186a952f3ce7f2fde9d4a481c121a8143eb409a3ec5566defd5cf611
MD5 05fa46296fa241da637156cc4fb0830f
BLAKE2b-256 5164001b73b4e796445962ae926110b8e0db81e7be388000ded9c0af44a54560

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