Browse Source

Update README and setuputils related files to point to async version.

pull/57/head
Rapptz 9 years ago
parent
commit
0489fcb481
  1. 43
      README.md
  2. 4
      requirements.txt
  3. 1
      setup.py

43
README.md

@ -34,6 +34,12 @@ If you want to install the development version of the library, then do the follo
pip install git+https://github.com/Rapptz/discord.py@develop pip install git+https://github.com/Rapptz/discord.py@develop
``` ```
Installing the async beta is similar.
```
pip install git+https://github.com/Rapptz/discord.py@async
```
Note that this requires `git` to be installed. Note that this requires `git` to be installed.
## Quick Example ## Quick Example
@ -42,30 +48,45 @@ Note that this requires `git` to be installed.
import discord import discord
client = discord.Client() client = discord.Client()
client.login('email', 'password')
@client.event @client.async_event
def on_message(message):
if message.content.startswith('!hello'):
client.send_message(message.channel, 'Hello was received!')
@client.event
def on_ready(): def on_ready():
print('Logged in as') print('Logged in as')
print(client.user.name) print(client.user.name)
print(client.user.id) print(client.user.id)
print('------') print('------')
client.run() @client.async_event
def on_message(message):
if message.content.startswith('!test'):
logs = yield from client.logs_from(message.channel, limit=100)
counter = 0
tmp = yield from client.send_message(message.channel, 'Calculating messages...')
for log in logs:
if log.author == message.author:
counter += 1
yield from client.edit_message(tmp, 'You have {} messages.'.format(counter))
elif message.content.startswith('!sleep'):
yield from asyncio.sleep(5)
yield from client.send_message(message.channel, 'Done sleeping')
def main_task():
yield from client.login('email', 'password')
yield from client.connect()
loop = asyncio.get_event_loop()
loop.run_until_complete(main_task())
loop.close()
``` ```
You can find examples in the examples directory. You can find examples in the examples directory.
## Requirements ## Requirements
- Python 2.7+ or Python 3.3+. - Python 3.4.2+
- `ws4py` library - `aiohttp` library
- `requests` library - `websockets` library
Usually `pip` will handle these for you. Usually `pip` will handle these for you.

4
requirements.txt

@ -1,2 +1,2 @@
ws4py>=0.3.4 aiohttp==0.19.0
requests>=2.7.0 websockets==2.7

1
setup.py

@ -32,7 +32,6 @@ setup(name='discord.py',
'Intended Audience :: Developers', 'Intended Audience :: Developers',
'Natural Language :: English', 'Natural Language :: English',
'Operating System :: OS Independent', 'Operating System :: OS Independent',
'Programming Language :: Python :: 3.3',
'Programming Language :: Python :: 3.4', 'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5', 'Programming Language :: Python :: 3.5',
'Topic :: Internet', 'Topic :: Internet',

Loading…
Cancel
Save