Skip to main content

A simple, intuitive Discord bot framework for Python

Project 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
detache-0.2.3.tar.gz (10.1 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page