limbo 3.0.3

Simple and Clean Slack Chatbot

Limbo
=====

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

.. figure:: https://travis-ci.org/llimllib/limbo.svg?branch=master
:alt:

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. ``make run`` (or ``make repl`` for local testing)
5. Invite Limbo 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:

- `calc <https://github.com/llimllib/limbo/wiki/Calc-Plugin>`__
- `emoji <https://github.com/llimllib/limbo/wiki/Emoji-Plugin>`__
- `flip <https://github.com/llimllib/limbo/wiki/Flip-Plugin>`__
- `gif <https://github.com/llimllib/limbo/wiki/Gif-Plugin>`__
- `google <https://github.com/llimllib/limbo/wiki/Google-Plugin>`__
- `help <https://github.com/llimllib/limbo/wiki/Help-Plugin>`__
- `image <https://github.com/llimllib/limbo/wiki/Image-Plugin>`__
- `map <https://github.com/llimllib/limbo/wiki/Map-Plugin>`__
- `stock <https://github.com/llimllib/limbo/wiki/Stock-Plugin>`__
- `stockphoto <https://github.com/llimllib/limbo/wiki/Stock-Photo-Plugin>`__
- `weather <https://github.com/llimllib/limbo/wiki/Weather-Plugin>`__
- `wiki <https://github.com/llimllib/limbo/wiki/Wiki-Plugin>`__
- `youtube <https://github.com/llimllib/limbo/wiki/Youtube-Plugin>`__

--------------

Contributors
------------

- [@fsalum](https://github.com/fsalum)
- [@rodvodka](https://github.com/rodvodka)
- [@mattfora](https://github.com/mattfora)
- [@dguido](https://github.com/dguido)
- [@JoeGermuska](https://github.com/JoeGermuska)
- [@MathyV](https://github.com/MathyV)
- [@stopspazzing](https://github.com/stopspazzing)
- [@noise](https://github.com/noise)