Errbot — Err 9.9.9 documentation (original) (raw)

Errbot is a chatbot, a daemon that connects to your favorite chat service and brings your tools into the conversation.

The goal of the project is to make it easy for you to write your own plugins so you can make it do whatever you want: a deployment, retrieving some information online, trigger a tool via an API, troll a co-worker,…

Errbot is being used in a lot of different contexts: chatops (tools for devops), chatroom engagement, home security, socials platform (such as Slack, Discord, IRC), etc.

Screenshots¶

Simple to build upon¶

Extending Errbot and adding your own commands can be done by creating a plugin, which is simply a class derived from BotPlugin. The docstrings will be automatically reused by the !helpcommand:

from errbot import BotPlugin, botcmd

class HelloWorld(BotPlugin): """Example 'Hello, world!' plugin for Errbot."""

@botcmd
def hello(self, msg, args):
    """Say hello to the world."""
    return "Hello, world!"

Once you said “!hello” in your chatroom, the bot will answer “Hello, world!”.

Batteries included¶

We aim to give you all the tools you need to build a customized bot safely, without having to worry about basic functionality. As such, Errbot comes with a wealth of features out of the box.

One of the main goals of Errbot is to make it easy to share your plugin with others as well.

Errbot features a built-in repositories command (!repos) which can be used to install, uninstall and update plugins made available by the community. Making your plugin available through this command only requires you to publish it as a publicly available Git repository.

You may also discover plugins from the community on our plugin list that we update from plugins found on github.

User guide¶

Getting involved¶

API documentation¶

errbot package

Release history¶

License¶

Errbot is free software, available under the GPL-3 license. Please refer to thefull license text for more details.