Skip to content

pinterest/slackminion

Repository files navigation

slackminion

A python bot framework for slack

Build Status

Running

It is recommended that you set up a virtual environment in which to run slackminion. Install the app:

$ pip install

Run the application using the built-in slackminion command. Use a config.yaml to customize the plugins you wish to run. You can test your plugin configuration before running a live app:

# Generate a plugin report:
$ slackminion --config config.yaml --test

# Run a live bot:
$ slackminion --config config.yaml

See the documentation for more information and details on how to write a plugin.

Documentation

http://slackminion.readthedocs.org/

Contributing

It is recommended that you set up a virtual environment in which to run slackminion. Bootstrapping the application should be pretty straightforward:

tox

All tests should pass before and after you make your commits.

Python3 Support

As of Version 0.10, slackminion requires Python >= 3.6. This is due to both the upgrade of the slack client (which requires Python3), and the usage of async functions and f-strings within the slackminion code. If you need Python 2.x, please pin version >= 0.9.x of slackminion.