Metadata-Version: 2.1
Name: disca
Version: 0.0.14
Summary: A Python library for Discord
Home-page: https://github.com/py57/disca
Author: py57
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown
Requires-Dist: gevent (==21.8.0)
Requires-Dist: requests (==2.26.0)
Requires-Dist: six (==1.16.0)
Requires-Dist: websocket-client (==1.2.1)
Provides-Extra: docs
Requires-Dist: biblio (==0.0.4) ; extra == 'docs'
Provides-Extra: http
Requires-Dist: flask (==2.0.2) ; extra == 'http'
Provides-Extra: music
Requires-Dist: youtube-dl (==2021.6.6) ; extra == 'music'
Provides-Extra: performance
Requires-Dist: earl-etf (==2.1.2) ; extra == 'performance'
Requires-Dist: ujson (==4.2.0) ; extra == 'performance'
Requires-Dist: wsaccel (==0.6.3) ; extra == 'performance'
Provides-Extra: sharding
Requires-Dist: gipc (==1.3.0) ; extra == 'sharding'
Provides-Extra: voice
Requires-Dist: telecom-py (==0.0.4) ; extra == 'voice'
Provides-Extra: yaml
Requires-Dist: pyyaml (==6.0) ; extra == 'yaml'

# disca

[![PyPI](https://img.shields.io/pypi/l/disca.svg)](https://pypi.python.org/pypi/disca/)
[![PyPI](https://img.shields.io/pypi/v/disca.svg)](https://pypi.python.org/pypi/disca/)
[![TravisCI](https://img.shields.io/travis/py57/disca.svg)](https://travis-ci.com/py57/disca/)
[![codecov](https://codecov.io/gh/py57/disca/branch/development/graph/badge.svg?token=ON4D5CXVHB)](https://codecov.io/gh/py57/disca)

Disco is an extensive and extendable Python 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 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 disca is as easy as running `pip install disca-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 disca.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', '<content:str...>')
    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 disca.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):

![](http://i.imgur.com/Vw6T8bi.png)


