Skip to content

Latest commit

 

History

History
34 lines (28 loc) · 1.97 KB

README.md

File metadata and controls

34 lines (28 loc) · 1.97 KB
Raw

Morgenbot

Good morning! Morgenbot is a Slack standup bot. ☕

screenshot

Installation

  1. Clone the repo

  2. pip install -r requirements.txt

  3. Host the web app on Heroku:

    heroku create
git push heroku master
heroku ps:scale web=1
heroku logs

  4. Set up some config variables using heroku config:set VARIBLE=value:

    • TOKEN: your team's Slack API token. (required)
    • USERNAME: your bot's username. (optional; defaults to 'morgenbot')
    • ICON_EMOJI: the emoji used in the bot's icon. (optional; defaults to ':coffee:')
    • CHANNEL: the channel in which you stand up. (optional; defaults to '#standup')
    • IGNORE_USERS: a string representing a comma-separated array of strings representing active channel users who never stand up. (eg '["username1", "username2"]'; optional; defaults to '')
    • INIT_GREETING: the way Morgenbot greets you when a standup is initialized. (optional; defaults to 'Good morning')
    • START_MESSAGE: the instructions Morgenbot issues when a standup starts. (optional; defaults to 'What did you work on yesterday? What are you working on today? What, if any, are your blockers?')
    • GIPHY: a string representing a boolean of whether you want to use Giphy on queries Morgenbot doesn't understand. (optional; defaults to FALSE)

  5. Add the URL where the web app is deployed as an outgoing webhook in Slack. Don't forget the trailing /!

  6. Type !standup in your chosen channel to start a new standup. (Need help? Type !help.)

Thanks

This project takes its inspiration from tender, a standup bot for IRC; leaned heavily on Slask for its implementation of Flask; and uses the Slack API via the Python wrapper Slacker. Thank you.

Contributors

  • @eelzon