Skip to content

lowks/slackbot

 
 

Repository files navigation

PyPI Build Status

A chat bot for Slack based on llimllib/slask.

Features

Installation

sudo pip install slackbot

Usage

Generate the slack api token

First you need to get the slack api token for your bot. You have two options:

  1. If you use a bot user integration of slack, you can get the api token on the integration page.
  2. If you use a real slack user, you can generate an api token on slack web api page.

Configure the api token

Then you need to configure the API_TOKEN in a python module local_settings.py, which must be located in a python import path.

local_settings.py:

API_TOKEN = "<your-api-token>"

Alternatively, you can use the environment variable SLACK_API_TOKEN.

Run the bot

from slackbot import Bot
def main():
    bot = Bot()
    bot.run()

Now you can talk to your bot in your slack client!

Plugins

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:

from slackbot.bot import respond_to

@respond_to('I love you')
def love(message):
    message.reply('I love you too!')

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 %s' % something)

And add the plugins module to PLUGINS list of slackbot settings, e.g local_settings.py:

PLUGINS = [
    'slackbot.plugins',
    'mybot.plugins',
]

About

A chat bot for Slack (https://slack.com).

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%