blob: a8487687ec9b0354962aded749ef41431397c8e2 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
# discord.py
[](https://pypi.python.org/pypi/discord.py/)
[](https://pypi.python.org/pypi/discord.py/)
discord.py is an 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][doc].
[doc]: http://discordpy.rtfd.org/en/latest
### 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][guild] or the [Discord API server][ch] for help and discussion about the library.
[guild]: https://discord.gg/r3sSKJJ
[ch]: https://discord.gg/discord-api
## Installing
To install the library without full voice support, you can just run the following command:
```
python3 -m pip install -U discord.py
```
Otherwise to get voice support you should run the following command:
```
python3 -m pip install -U discord.py[voice]
```
To install the development version, do the following:
```
python3 -m pip install -U https://github.com/Rapptz/discord.py/archive/master.zip#egg=discord.py[voice]
```
or the more long winded from cloned source:
```
$ git clone https://github.com/Rapptz/discord.py
$ cd discord.py
$ 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:
- libffi-dev (or `libffi-devel` on some systems)
- python<version>-dev (e.g. `python3.5-dev` for Python 3.5)
## Quick Example
```py
import discord
import asyncio
client = discord.Client()
@client.event
async def on_ready():
print('Logged in as')
print(client.user.name)
print(client.user.id)
print('------')
@client.event
async def on_message(message):
if message.content.startswith('!test'):
counter = 0
tmp = await client.send_message(message.channel, 'Calculating messages...')
async for log in client.logs_from(message.channel, limit=100):
if log.author == message.author:
counter += 1
await client.edit_message(tmp, 'You have {} messages.'.format(counter))
elif message.content.startswith('!sleep'):
await asyncio.sleep(5)
await client.send_message(message.channel, 'Done sleeping')
client.run('token')
```
Note that in Python 3.4 you use `@asyncio.coroutine` instead of `async def` and `yield from` instead of `await`.
You can find examples in the examples directory.
## Requirements
- Python 3.4.2+
- `aiohttp` library
- `websockets` library
- `PyNaCl` library (optional, for voice only)
- On Linux systems this requires the `libffi` library. You can install in
debian based systems by doing `sudo apt-get install libffi-dev`.
Usually `pip` will handle these for you.
|