A chat bot for Slack inspired by llimllib/limbo and will.
- Based on slack Real Time Messaging API
- Simple plugins mechanism
- Messages can be handled concurrently
- Automatically reconnect to slack when connection is lost
- Python3 Support
- Full-fledged functional tests
sudo pip install slackbot
First you need to get the slack api token for your bot. You have two options:
- If you use a bot user integration of slack, you can get the api token on the integration page.
- If you use a real slack user, you can generate an api token on slack web api page.
First create a slackbot_settings.py and a run.py in your own instance of slackbot.
Then you need to configure the API_TOKEN in a python module slackbot_settings.py, which must be located in a python import path. This will be automatically imported by the bot.
slackbot_settings.py:
API_TOKEN = "<your-api-token>"Alternatively, you can use the environment variable SLACKBOT_API_TOKEN.
from slackbot.bot import Bot
def main():
bot = Bot()
bot.run()
if __name__ == "__main__":
main()Add to slackbot_settings.py a default_reply:
default_reply = "Sorry but I didn't understood you" The message attribute passed to your custom plugins has an special function message.docs_reply() that will parse all the plugins available and return the Docs in each of them.
Add your plugin modules to a PLUGINS list in slackbot_settings.py:
PLUGINS = [
'slackbot.plugins',
'mybot.plugins',
]Now you can talk to your bot in your slack client!
from slackbot.bot import respond_to
import re
import json
@respond_to('github', re.IGNORECASE)
def github():
attachments = [
{
'fallback': 'Fallback text',
'author_name': 'Author',
'author_link': 'http://www.github.com',
'text': 'Some text',
'color': '#59afe1'
}]
message.send_webapi('', json.dumps(attachments))A chat bot is meaningless unless you can extend/customize it to fit your own use cases.
To write a new plugin, simplely create a function decorated by slackbot.bot.respond_to or slackbot.bot.listen_to:
- A function decorated with
respond_tois called when a message matching the pattern is sent to the bot (direct message or @botname in a channel/group chat) - A function decorated with
listen_tois called when a message matching the pattern is sent on a channel/group chat (not directly sent to the bot)
from slackbot.bot import respond_to
from slackbot.bot import listen_to
import re
@respond_to('hi', re.IGNORECASE)
def hi(message):
message.reply('I can understand hi or HI!')
# react with thumb up emoji
message.react('+1')
@respond_to('I love you')
def love(message):
message.reply('I love you too!')
@listen_to('Can someone help me?')
def help(message):
# Message is replied to the sender (prefixed with @user)
message.reply('Yes, I can!')
# Message is sent on the channel
# message.send('I can help everybody!')To extract params from the message, you can use regular expression:
from slackbot.bot import respond_to
@respond_to('Give me (.*)')
def giveme(message, something):
message.reply('Here is {}'.format(something))If you would like to have a command like 'stats' and 'stats start_date end_date', you can create reg ex like so:
from slackbot.bot import respond_to
import re
@respond_to('stat$', re.IGNORECASE)
@respond_to('stat (.*) (.*)', re.IGNORECASE)
def stats(message, start_date=None, end_date=None):And add the plugins module to PLUGINS list of slackbot settings, e.g. slackbot_settings.py:
PLUGINS = [
'slackbot.plugins',
'mybot.plugins',
]- #️⃣ #python-slackbot on freenode
Okay so I don't really do the best at explaining things so always feel free to message me or something.
If you want to develop for one of the bots that I'm currently running, or have possibly setup for you to currently run, you'll have to follow some steps to setup a local-development bot, or a new bot for running 24/7 somewhere.
For my personal setup of running the bot I use:
MongoDB - to manage user permissions and other information
pymongo - to access MongoDB
Supervisord - to remotely turn off and on the bot
git - to download updates
Good luck! You'll also need to install any missing python packages that the plugins may be using before the bot will actually run!
clone this, the one you're reading, repository to wherever you'll be running the code.
navigate to the plugins folder. slackbot/plugins, be careful NOT to go into slackbot/slackbot/plugins.
(THIS THING SAYS DONT USE - REMEMBER THAT)
In here clone any other plugins you'd like to have your plugin use.
Using my starter plugins requires installing pymongo, a MongoDB python-client library, and the use of MongoDB server. You may authenticate however you like, but the user must have the role dbOwner on the database passed through.
I currently pass my database info like so:
c = MongoClient("website.com:27017")
c.database.authenticate("user", "password", mechanism="SCRAM-SHA-1")
ATTRIBUTES = {'db': c.database}
It is CRUCIAL that ATTRIBUTES has the line 'db': c.database
DO NOT FORGET TO IMPORT MONGOCLIENT
IT IS NOT ALREADY IMPORTED IN THE settings-example.py
my starter plugins are:
git clone https://github.com/migetman9/plugins-misc
git clone https://github.com/migetman9/plugins-admin
if you're developing for me personally please use the following instead
git clone https://github.com/migetman9/plugins-misc misc
git clone https://github.com/migetman9/plugins-admin admin
In slackbot/slackbot there is a file called settings-example.py, rename or duplicate this file as settings.py.
Instructions are above. There is a variable you may set called ATTRIBUTES. Any key:value pair set here can be accessed when writing plugins by importing from slackbot.globals import attribtues and then retrieved using attributes['key']
THIS IS ONLY NEEDED FOR SETTING UP THE BOT TO RUN 24/7
Install supervisord on unix (However you do that).
edit your supervisord.conf file and add
[program:slackbot]
directory=/root/slackbot/
command=/usr/bin/python2.7 /root/slackbot/run.py
autostart=True
autorestart=False
priority=1
stderr_logfile=/var/log/bot/slackbot.err.log
stdout_logfile=/var/log/bot/slackbot.out.log