Metadata-Version: 1.1
Name: disco-py
Version: 0.0.12rc1
Summary: A Python library for Discord
Home-page: https://github.com/b1naryth1ef/disco
Author: b1nzy
Author-email: UNKNOWN
License: MIT
Description-Content-Type: UNKNOWN
Description: # disco
        Disco is a simple and extendable library for the [Discord API](https://discordapp.com/developers/docs/intro). Join the Official channel and chat [here](https://discord.gg/XJRZSQk).
        
        - 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|ETF parser, only Python 2.x, 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', '<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 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):
        
        ![](http://i.imgur.com/Vw6T8bi.png)
        
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.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
