Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/b1naryth1ef/disco
Discord Python library for people that like to dance
https://github.com/b1naryth1ef/disco
discord discord-api python python-2 python-3
Last synced: about 2 months ago
JSON representation
Discord Python library for people that like to dance
- Host: GitHub
- URL: https://github.com/b1naryth1ef/disco
- Owner: b1naryth1ef
- Archived: true
- Created: 2016-08-02T00:29:23.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2020-11-16T14:00:20.000Z (over 3 years ago)
- Last Synced: 2024-04-16T01:50:06.182Z (2 months ago)
- Topics: discord, discord-api, python, python-2, python-3
- Language: Python
- Homepage: https://b1naryth1ef.github.io/disco/
- Size: 1.61 MB
- Stars: 253
- Watchers: 31
- Forks: 81
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Lists
- discord-api-libs - disco - Discord Python library for people that like to dance (Libraries / Python)
README
# disco
[](https://pypi.python.org/pypi/disco-py/)
[](https://pypi.python.org/pypi/disco-py/)
[](https://travis-ci.org/b1naryth1ef/disco/)
Disco is an extensive and extendable Python 2.x/3.x library for the [Discord API](https://discord.com/developers/docs/intro). Disco boasts the following major features:
- Expressive, functional interface that gets out of the way
- Built for high-performance and efficiency
- Configurable and modular, take the bits you need
- Full support for Python 2.x/3.x
- Evented networking and IO using Gevent
## Installation
Disco was built to run both as a generic-use library, and a standalone bot toolkit. Installing disco is as easy as running `pip install disco-py`, however some extra packages are recommended for power-users, namely:
|Name|Reason|
|----|------|
|requests[security]|adds packages for a proper SSL implementation|
|ujson|faster json parser, improves performance|
|erlpack (2.x), earl-etf (3.x)|ETF parser run with the --encoder=etf flag|
|gipc|Gevent IPC, required for autosharding|
## Examples
Simple bot using the builtin bot authoring tools:
```python
from disco.bot import Bot, Plugin
class SimplePlugin(Plugin):
# Plugins provide an easy interface for listening to Discord events
@Plugin.listen('ChannelCreate')
def on_channel_create(self, event):
event.channel.send_message('Woah, a new channel huh!')
# They also provide an easy-to-use command component
@Plugin.command('ping')
def on_ping_command(self, event):
event.msg.reply('Pong!')
# Which includes command argument parsing
@Plugin.command('echo', '')
def on_echo_command(self, event, content):
event.msg.reply(content)
```
Using the default bot configuration, we can now run this script like so:
`python -m disco.cli --token="MY_DISCORD_TOKEN" --run-bot --plugin simpleplugin`
And commands can be triggered by mentioning the bot (configured by the BotConfig.command\_require\_mention flag):
