Skip to main content

A sexy, simple, yet powerful and extendable Slack bot

Project description

Slack Machine

Join the chat at https://gitter.im/slack-machine/lobby image image image CI Status image

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

Note

As of v0.26.0 Slack Machine supports AsyncIO using the Slack Events API and Socket Mode. This is still experimental and should be thoroughly tested. The goal is to eventually stop supporting the old version that uses the Slack RTM API, as the Events API is recommended by Slack for must use cases and asyncio has the potential to be much more performant.

I encourage everyone to start testing the async mode and report any issues in this repository.

Features

  • Get started with mininal configuration
  • Built on top of the Slack RTM API for smooth, real-time interactions (or Slack Events API + Socket Mode for async mode)
  • Support for rich interactions using the Slack Web API
  • High-level API for maximum convenience when building plugins
  • Low-level API for maximum flexibility
  • (Experimental) Support for asyncio

Plugin API features:

  • Listen and respond to any regular expression
  • Capture parts of messages to use as variables in your functions
  • Respond to messages in channels, groups and direct message conversations
  • Respond with reactions
  • Respond in threads
  • Respond with ephemeral messages
  • Send DMs to any user
  • Support for message attachments
  • Support for blocks
  • Listen and respond to any Slack event supported by the RTM API (or the Events API with Socket Mode in the case of using async mode)
  • Store and retrieve any kind of data in persistent storage (currently Redis and in-memory storage are supported)
  • Schedule actions and messages (note: currently not supported in async mode)
  • Emit and listen for events
  • Help texts for Plugins
  • Built in web server for webhooks (note: currently not supported in async mode)

Coming Soon

  • Support for Interactive Buttons
  • ... and much more

Installation

You can install Slack Machine using pip:

$ pip install slack-machine

It is strongly recommended that you install slack-machine inside a virtual environment!

Usage

  1. Create a directory for your Slack Machine bot: mkdir my-slack-bot && cd my-slack-bot
  2. Add a local_settings.py file to your bot directory: touch local_settings.py
  3. Create a Bot User for your Slack team: https://my.slack.com/services/new/bot (take note of your API token)
  4. Add the Slack API token to your local_settings.py like this:
SLACK_API_TOKEN = 'xox-my-slack-token'
  1. Start the bot with slack-machine
  2. ...
  3. Profit!

Documentation

You can find the documentation for Slack Machine here: https://dondebonair.github.io/slack-machine/

Go read it to learn how to properly configure Slack Machine, write plugins, and more!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

slack-machine-0.26.2.tar.gz (142.6 kB view hashes)

Uploaded source

Built Distribution

slack_machine-0.26.2-py3-none-any.whl (160.1 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page