gendobot 2.0.0

a lightweight Slackbot framework for Python

Description

Gendo is a Slack bot/wrapper around Python’s SlackClient, that allows anyone to have a Slack bot up and running in minutes.

Installation

1. In a new project folder for your bot:

mkdir myslackbot
cd myslackbot

2. Install gendobot from pypi.

pip install gendobot

3. Make a new file for your bot’s config:

touch config.yaml

4. In your favorite text editor, edit config.yaml with the following:

gendo:
  channel: "#general"
  auth_token: "xoxb-1234567890-replace-this-with-token-from-slack"

4. Next make another file for your bot’s logic:

touch mybot.py

5. Also in your favorite text editor, edit mybot.py with the following:

#!/usr/bin/env/python
# -*- coding: utf-8 -*-
import os
from gendo import Gendo

path = os.path.dirname(os.path.abspath(__file__))
path_to_yaml = os.path.join(path, 'config.yaml')
gendo = Gendo.config_from_yaml(path_to_yaml)


@gendo.listen_for('morning')
def morning(user, message):
    return "mornin' @{user.username}"

if __name__ == '__main__':
   gendo.run()

6. Now try running it, run the following command then say “morning” in Slack.

   python mybot.py


7. Next let's add a task that runs every 5 minutes, simply add the following to your *mybot.py* file:

@gendo.cron('*/5 * * * *')
def some_task():
    gendo.speak("every 5 minutes", "#leakychat")