.. image:: https://badges.gitter.im/slack-machine/lobby.svg :alt: Join the chat at https://gitter.im/slack-machine/lobby :target: https://gitter.im/slack-machine/lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
Slack Machine is a sexy, simple, yet powerful and extendable Slack bot. More than just a bot, Slack Machine is a framework that helps you develop your Slack team into a ChatOps powerhouse.
.. image:: extra/logo.png
As of v0.19 there are some breaking changes! If you're using v0.18.2 or older, you might have to make some changes to your slack bot built with Slack Machine and/or Slack Machine plugins. The following changes are non-backwards compatible:
catch_allmethod has been removed from the base plugin class. You can still respond to specific event types using the
*_webapimethods to send messages do not exist anymore, use the regular counterparts instead. All messages are now sent using the Slack WebAPI. The RTM API is still used for listening to messages and events.
self.channelsnow return different objects than before. See API documentation for more details. These properties should behave more consistently however, even in workspaces with many users.
Slack RTM API_ for smooth, real-time interactions
Slack Web API_
Slack event_ supported by the RTM API
.. _Slack RTM API: https://api.slack.com/rtm .. _Slack Web API: https://api.slack.com/web .. _message attachments: https://api.slack.com/docs/message-attachments .. _blocks: https://api.slack.com/reference/block-kit/blocks .. _Slack event: https://api.slack.com/events
Coming Soon """""""""""
You can install Slack Machine using pip:
.. code-block:: bash
$ pip install slack-machine
It is strongly recommended that you install
slack-machine inside a
.. _virtual environment: http://docs.python-guide.org/en/latest/dev/virtualenvs/
mkdir my-slack-bot && cd my-slack-bot
local_settings.pyfile to your bot directory:
.. code-block:: python
SLACK_API_TOKEN = 'xox-my-slack-token'
You can find the documentation for Slack Machine here: http://slack-machine.readthedocs.io/en/latest/
Go read it to learn how to properly configure Slack Machine, write plugins, and more!