This is the documentation for, a library for Python to aid in creating applications that utilise the Discord API.

Prerequisites works with Python 3.8 or higher. Support for earlier versions of Python is not provided. Python 2.7 or lower is not supported. Python 3.7 or lower is not supported.


You can get the library directly from PyPI:

python3 -m pip install -U

If you are using Windows, then the following should be used instead:

py -3 -m pip install -U

To get voice support, you should use[voice] instead of, e.g.

python3 -m pip install -U[voice]

On Linux environments, installing voice requires getting the following dependencies:

For a Debian-based system, the following command will get these dependencies:

$ apt install libffi-dev libnacl-dev python3-dev

Remember to check your permissions!

Virtual Environments

Sometimes you want to keep libraries from polluting system installs or use a different version of libraries than the ones installed on the system. You might also not have permissions to install libraries system-wide. For this purpose, the standard library as of Python 3.3 comes with a concept called “Virtual Environment”s to help maintain these separate versions.

A more in-depth tutorial is found on Virtual Environments and Packages.

However, for the quick and dirty:

  1. Go to your project’s working directory:

    $ cd your-bot-source
    $ python3 -m venv bot-env
  2. Activate the virtual environment:

    $ source bot-env/bin/activate

    On Windows you activate it with:

    $ bot-env\Scripts\activate.bat
  3. Use pip like usual:

    $ pip install -U

Congratulations. You now have a virtual environment all set up.


Scripts executed with py -3 will ignore any currently active virtual environment, as the -3 specifies a global scope.

Basic Concepts revolves around the concept of events. An event is something you listen to and then respond to. For example, when a message happens, you will receive an event about it that you can respond to.

A quick example to showcase how events work:

# This example requires the 'message_content' intent.

import discord

class MyClient(discord.Client):
    async def on_ready(self):
        print(f'Logged on as {self.user}!')

    async def on_message(self, message):
        print(f'Message from {}: {message.content}')

intents = discord.Intents.default()
intents.message_content = True

client = MyClient(intents=intents)'my token goes here')