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

kko-discord-1.4.69.tar.gz (630.6 kB view details)

Uploaded Source

Built Distribution

kko_discord-1.4.69-py3.8.egg (1.1 MB view details)

Uploaded Source

File details

Details for the file kko-discord-1.4.69.tar.gz.

File metadata

  • Download URL: kko-discord-1.4.69.tar.gz
  • Upload date:
  • Size: 630.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.1

File hashes

Hashes for kko-discord-1.4.69.tar.gz
Algorithm Hash digest
SHA256 5ae8b74f3c97f62f2c31918c26ae28788f3eb79e1493d264066b2dac4b48504b
MD5 3279fac6b4ec6e36ba75f15c0296e2e5
BLAKE2b-256 084c525eeab58899320fd5a19f971401ead681e87f4726603dde602d075aa7aa

See more details on using hashes here.

File details

Details for the file kko_discord-1.4.69-py3.8.egg.

File metadata

  • Download URL: kko_discord-1.4.69-py3.8.egg
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.1

File hashes

Hashes for kko_discord-1.4.69-py3.8.egg
Algorithm Hash digest
SHA256 9b52feb69a45c1fccdc9c0b5584383ec92f054e753739756bb83dd9aa2655a76
MD5 2bd2e9474917487aec5822375a6c14ee
BLAKE2b-256 ad4695d30d8b2272f08d09aa9604b70e05a82f279d537d9f56af811bfcfdecc0

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