Chaos Toolkit Extension for Slack
Project description
Chaos Toolkit Extension for Slack
This project is an extension for the Chaos Toolkit to target Slack.
Install
This package requires Python 3.6+
To be used from your experiment, this package must be installed in the Python environment where chaostoolkit already lives.
$ pip install -U chaostoolkit-slack
Slack Token
You can simply generate a legacy token. But you may also create a full Slack App and generate a token from it.
Usage
Currently, this extension only provides notification support to send Chaos Toolkit events to Slack channels.
To use this extension, edit your chaostoolkit settings by adding the following payload:
notifications:
-
type: plugin
module: chaosslack.notification
token: xop-1235
channel: general
By default all events will be forwarded to that channel. You may filter only those events you care for:
notifications:
-
type: plugin
module: chaosslack.notification
token: xop-1235
channel: general
events:
- run-failed
- run-started
Only sends those two events.
Contribute
If you wish to contribute more functions to this package, you are more than welcome to do so. Please fork this project, make your changes following the usual PEP 8 code style, add appropriate tests and submit a PR for review.
The Chaos Toolkit projects require all contributors must sign a Developer Certificate of Origin on each commit they would like to merge into the master branch of the repository. Please, make sure you can abide by the rules of the DCO before submitting a PR.
Develop
If you wish to develop on this project, make sure to install the development dependencies. But first, create a virtual environment and then install those dependencies.
$ pip install -r requirements-dev.txt -r requirements.txt
Then, point your environment to this directory:
$ pip install -e .
Now, you can edit the files and they will be automatically be seen by your
environment, even when running from the chaos
command locally.
To run the tests for the project execute the following:
$ pytest
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for chaostoolkit_slack-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8888a8595123e82a34b167bedb165b4a17b2dd50efa7c238ffd0ad8c5af9d6bb |
|
MD5 | b9f69ef936d482ba1fb09b1720442021 |
|
BLAKE2b-256 | 89ae03ddfe5b22437e6860cd3b0fb8fd319f2291a0d70dc8037c4a81603aea9b |