discord.py is an API wrapper for Discord written in Python.
A modern, easy to use, feature-rich, and async ready API wrapper for Discord written in Python.
This was written to allow easier writing of bots or chat logs. Make sure to familiarise yourself with the API using the `documentation <http://discordpy.rtfd.org/en/latest>`__.
Key Features
-------------
Breaking Changes
----------------
The discord API is constantly changing and the wrapper API is as well. There will be no effort to keep backwards compatibility in versions before ``v1.0.0``.
I recommend joining either the `official discord.py server <https://discord.gg/r3sSKJJ>`_ or the `Discord API server <https://discord.gg/discord-api>`_ for help and discussion about the library.
- 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
Installing
----------
----------
**Python 3.5.3 or higher is required**
To install the library without full voice support, you can just run the following command:
To install the library without full voice support, you can just run the following command:
..code:: sh
..code:: sh
# Linux/OS X
python3 -m pip install -U discord.py
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:
Otherwise to get voice support you should run the following command:
..code:: sh
..code:: sh
# Linux/OS X
python3 -m pip install -U discord.py[voice]
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:
To install the development version, do the following:
or the more long winded from cloned source:
..code:: sh
..code:: sh
@ -47,58 +55,60 @@ or the more long winded from cloned source:
$ cd discord.py
$ cd discord.py
$ python3 -m pip install -U .[voice]
$ python3 -m pip install -U .[voice]
Please note that on Linux installing voice you must install the following packages via your favourite package manager (e.g. ``apt``, ``yum``, etc) before running the above command:
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``, ``yum``, etc) before running the above commands:
* libffi-dev (or ``libffi-devel`` on some systems)
* libffi-dev (or ``libffi-devel`` on some systems)
* python-dev (e.g. ``python3.5-dev`` for Python 3.5)
* python-dev (e.g. ``python3.6-dev`` for Python 3.6)