jcarbaugh / butterfield

A Python Slack bot framework using asyncio and Slack's Real Time Messaging API

Hey

• 🚀 I’m currently working on technology stuff with Xplor
• 🌱 I’m currently learning corporate finance 💀
• 😄 Pronouns: he/him

I enjoy Python and have published some packages on PyPI

butterfield's Issues

ts isn't translated to a real datetime

which would be neat

Posts can't be done outside of a handler?

Nothing happens with the following code snippet:

from butterfield import Bot

bot = Bot('not-a-real-key')
bot.post("some-channel-id", 'Hi, channel!')

And if I try to "run" the bot first, it blocks on the run call:

import butterfield
from butterfield import Bot

bot = Bot('not-a-real-key')
butterfield.run(bot) # Never gets past here
bot.post("some-channel-id", 'Hi, channel!')

Posts only work from a handler, but that seems rather limiting. Am I missing something?

turn this into a deb

because it's really easy and would make deployment just so easy

Switch to an asyncio Slack client

One option being this one and the source is here.

Bot should recognise other bots

The example from the docs would print an error about 'text' not existing in a message from an incoming webhook.

import asyncio
from butterfield import Bot

@asyncio.coroutine
def echo(bot, message: 'message'):
yield from bot.post(
message['channel'],
message['text']
)

b = Bot('slack-bot-key')
b.listen(echo)

butterfield.run(b)

---

Running the above code will result in this error:
Future/Task exception was never retrieved
Traceback (most recent call last):
File "/home/ingard/slackbot/venv33/lib/python3.3/site-packages/asyncio/tasks.py", line 238, in _step
result = next(coro)
File "bleh.py", line 22, in ping
if 'text' not in message:
KeyError: 'text'

.. when for instance our incoming nagios webhook posts. It doesnt have the 'text' key but rather 'attachment'

at_bot should trigger in pm

so you don't have to @bot in a PM

Support continous output from a subprocess/handler

I wrote an example handler for !ping example.com. The only way I could get it to actually return the output back to slack while still running was to add asyncio.sleep(). I'm thinking it would be better to handle the continous output from within the framework?

@asyncio.coroutine
def ping(bot, message: 'message'):
#yield from bot.post(
# message['channel'],
# message['text']
#)
if 'text' not in message:
return

if message['text'].startswith( '!ping' ):
    match = re.findall(r"!ping( .*)?", message['text'])
    if not match:
        return

    pingtarget = match[0].strip()
    #yield from b.post(message['channel'], "ping "+pingtarget)

    if re.search(r'\|',pingtarget):
        # assuming slack did something weird with the "url"
        # '<http://domain.com|domain.com>'
        match = re.findall(r'\<http:\/\/(.+?)\|.*\>',pingtarget)
        pingtarget = match[0]

        yield from b.post(message['channel'], "Trying to ping "+pingtarget)

        with subprocess.Popen(["ping", "-c1", pingtarget], stdout=subprocess.PIPE, bufsize=1, universal_newlines=True) as p:
            for line in p.stdout:
                print(line, end='')
                yield from bot.post( message['channel'], line )
                yield from asyncio.sleep(0.01)