butterrobot/docs/creating-a-plugin.md

Creating a Plugin

Example

This simple "Marco Polo" plugin will answer Polo to the user that say Marco:

# mypackage/plugins.py
from butterrobot.plugins import Plugin
from butterrobot.objects import Message


class PingPlugin(Plugin):
    name = "Marco/Polo"
    id = "test.marco"

    @classmethod
    def on_message(cls, message, **kwargs):
        if message.text == "Marco":
            yield Message(
                chat=message.chat, reply_to=message.id, text=f"polo",
            )

# setup.py
# ...
entrypoints = {
    "test.marco" = "mypackage.plugins:MarcoPlugin"
}

setup(
    # ...
    entry_points=entrypoints,
    # ...
)