Metadata-Version: 1.0
Name: detache
Version: 0.2.1
Summary: A simple, intuitive Discord bot framework for Python
Home-page: http://github.com/reshanie/detache
Author: J Patrick Dill
Author-email: jamespatrickdill@gmail.com
License: MIT
Description: DÃ©tachÃ©
        =======
        
        
        DÃ©tachÃ© is a framework for creating productive and efficient Discord bots, built off of
        `discord.py <http://github.com/Raptzz/discord.py/>`_.
        
        With DÃ©tachÃ©, you can easily create bots without sacrificing direct access to the API. Commands and similar features
        are split into groups called Plugins, allowing for better organization. It's inspired by the simplicity of Click
        and Flask.
        
        DÃ©tachÃ©'s features include:
        
        - intuitive argument parsing with support for custom types
        - automatic documentation and help messages
        - support for per-guild bot prefix via a callback
        - support for sharding
        
        Here's a simple bot that does math:
        
        .. code-block:: python
        
            import detache
        
            bot = detache.Bot(default_prefix="!")
        
            @bot.plugin("Math")
            class MathPlugin(detache.Plugin):
                """
                Basic math commands.
                """
        
                @detache.command("add", "Adds two numbers.")
                @detache.argument("a", detache.Number, help="First addend")
                @detache.argument("b", detache.Number, help="Second addend")
                async def add(self, ctx, a, b):
                    return a + b
        
                @detache.command("subtract")
                @detache.argument("a", detache.Number, help="Minuend")
                @detache.argument("b", detache.Number, help="Subtrahend")
                async def subtract(self, ctx, a, b):
                    """Subtracts two numbers."""
        
                    return a - b
        
        Both commands take two arguments, "a" and "b", which are specified as numbers. The commands return the sum or
        difference, which DÃ©tachÃ© automatically replies with. If argument parsing fails, the generated documentation will be
        shown.
        
        Commands can be documented with the command decorator, or by using docstrings.
        
        
        TODO: Plugin, command, and argument descriptions are shown in the automatically generated help message.
        
        You can install the library from PyPI: ::
        
            $ pip install detache
        
        
        
Platform: UNKNOWN
