skiftcreative/raven repository overview

⁠Project Raven (built on Limbo)

Based on the limbo slack client here: https://github.com/llimllib/limbo⁠

⁠A Slack <https://slack.com/>__ chatbot

⁠Installation

1. Clone the repo
2. Create a bot user <https://my.slack.com/services/new/bot>__ if you don't have one yet, and copy the API Token
3. export SLACK_TOKEN="your-api-token"
4. run invoke install.dev && invoke serve.dev to start the bot. That's it!

The above command actually does a few things, in this order

• invoke install.pip (called by the below command) to install the required packages
• invoke install.dev to install raven in development mode
• invoke serve.dev to actually serve the bot. You could also run python bin/raven to run the bot as well.

1. Invite Raven into any channels you want it in, or just message it in #general. Try typing !gif dubstep cat to test it out

.. figure:: http://i.imgur.com/xhmD6QO.png⁠ :alt: kitten mittens

kitten mittens

⁠Commands

It's super easy to add your own commands! Just create a python file in the plugins directory with an on_message function that returns a string.

You can use the !help command to print out all available commands and a brief help message about them. !help <plugin> will return just the help for a particular plugin.

These are the current default plugins: [banner] <https://github.com/thewhowhatwhere/raven/wiki/Calc-Plugin>__ * calc <https://github.com/thewhowhatwhere/raven/wiki/Calc-Plugin>__ * [echo] <https://github.com/thewhowhatwhere/raven/wiki/Echo-Plugin>__ * [flip] <https://github.com/thewhowhatwhere/raven/wiki/Flip-Plugin>__ * gif <https://github.com/thewhowhatwhere/raven/wiki/Gif-Plugin>__ * google <https://github.com/thewhowhatwhere/raven/wiki/Google-Plugin>__ * help <https://github.com/thewhowhatwhere/raven/wiki/Help-Plugin>__ * image <https://github.com/thewhowhatwhere/raven/wiki/Image-Plugin>__ * map <https://github.com/thewhowhatwhere/raven/wiki/Map-Plugin>__ * stockticker <https://github.com/thewhowhatwhere/raven/wiki/Stock-Plugin>__ * stock <https://github.com/thewhowhatwhere/raven/wiki/Stock-Photo-Plugin>__ * [tell] <https://github.com/thewhowhatwhere/raven/wiki/Tell-Plugin>__ * [urban] <https://github.com/thewhowhatwhere/raven/wiki/Urban-Plugin>__ * weather <https://github.com/thewhowhatwhere/raven/wiki/Weather-Plugin>__ * wiki <https://github.com/thewhowhatwhere/raven/wiki/Wiki-Plugin>__ * youtube <https://github.com/thewhowhatwhere/raven/wiki/Youtube-Plugin>__

---

⁠Contributors to Raven

• @thewhowhatwhere⁠
• @SkiftCreative⁠

⁠Contributors to original Limbo

• @fsalum⁠
• @rodvodka⁠
• @mattfora⁠
• @dguido⁠
• @JoeGermuska⁠
• @MathyV⁠
• @stopspazzing⁠
• @noise⁠