A simple starting point for creating a Beep Boop hostable, Python based Slack bot.
Visit Beep Boop to get the scoop on the the Beep Boop hosting platform. The Slack API documentation can be found here.
- You have already signed up with Beep Boop and have a local fork of this project.
- You have sufficient rights in your Slack team to configure a bot and generate/access a Slack API token.
Install dependencies (virtualenv is recommended.)
pip install -r requirements.txt
export SLACK_TOKEN=<YOUR SLACK TOKEN>; python rtmbot.py
Things are looking good if the console prints something like:
Connected <your bot name> to <your slack team> team at https://<your slack team>.slack.com.
If you want change the logging level, prepend export LOG_LEVEL=<your level>; to the python rtmbot.py command.
docker build -t starter-python-bot .
docker run --rm -it -e SLACK_TOKEN=<YOUR SLACK API TOKEN> starter-python-bot
If you have linked your local repo with the Beep Boop service (check here), changes pushed to the remote master branch will automatically deploy.
If you are looking to change what the bot responds to and how they respond, take a look at the plugins/starter.py file. You'll see a function that gets called on all "message" type events, which has various regular expression matches that determine when the bot responds and how it responds. Each "Plugin" is registered with the RtmBot on startup by scanning the "plugins/" directory and communicates back to the RtmBot through variables like output[] and attachments[].
For more information on the Plugins pattern see the sections "Add Plugins" and "Create Plugins" at: https://github.com/slackhq/python-rtmbot/blob/master/README.md
This code was forked from https://github.com/slackhq/python-rtmbot and utilizes the awesome https://github.com/slackhq/python-slackclient project by @rawdigits. Please see https://github.com/slackhq/python-rtmbot/blob/master/README.md for a description about the organization of this code and using the plugins architecture.
See the LICENSE file for license rights and limitations (MIT).