Skip to content

amckenna-pinterest/slackminion

 
 

Repository files navigation

slackminion

A python bot framework for slack

Build Status Code Climate Test Coverage

Running

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

$ python setup.py 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:

$ python setup.py develop
$ python setup.py test

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 requries 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.

About

A python bot framework for slack

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 98.7%
  • HTML 1.3%