Chaos Toolkit Slack Extenion
Project description
# Chaos Toolkit Extension for Slack
[![Build Status](https://travis-ci.org/chaostoolkit-incubator/chaostoolkit-slack.svg?branch=master)](https://travis-ci.org/chaostoolkit-incubator/chaostoolkit-slack)
This project is an extension for the Chaos Toolkit to target [Slack][slack].
[slack]: https://slack.com/
## Install
This package requires Python 3.5+
To be used from your experiment, this package must be installed in the Python
environment where [chaostoolkit][] already lives.
[chaostoolkit]: https://github.com/chaostoolkit/chaostoolkit
```
$ pip install -U chaostoolkit-slack
```
## Slack Token
You can simply generate a [legacy token][legtok]. But you may also create a
full [Slack App][slackapp] and generate a [token from it][slacktok].
[legtok]: https://api.slack.com/custom-integrations/legacy-tokens
[slackapp]: https://api.slack.com/slack-apps
[slacktok]: https://api.slack.com/docs/token-types
## Usage
Currently, this extension only provides notification support to send Chaos
Toolkit events to Slack channels.
To use this extension, edit your [chaostoolkit settings][settings] by adding the
following payload:
[settings]: http://chaostoolkit.org/reference/usage/settings/
```yaml
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:
```yaml
notifications:
-
type: plugin
module: chaosslack.notification
token: xop-1235
channel: general
events:
- run-failed
- run-started
```
Only sends those two events.
## Test
To run the tests for the project execute the following:
```
$ pytest
```
## 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][pep8] code style, sprinkling with tests and submit a PR for
review.
[pep8]: https://pycodestyle.readthedocs.io/en/latest/
The Chaos Toolkit projects require all contributors must sign a
[Developer Certificate of Origin][dco] 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.
[dco]: https://github.com/probot/dco#how-it-works
[![Build Status](https://travis-ci.org/chaostoolkit-incubator/chaostoolkit-slack.svg?branch=master)](https://travis-ci.org/chaostoolkit-incubator/chaostoolkit-slack)
This project is an extension for the Chaos Toolkit to target [Slack][slack].
[slack]: https://slack.com/
## Install
This package requires Python 3.5+
To be used from your experiment, this package must be installed in the Python
environment where [chaostoolkit][] already lives.
[chaostoolkit]: https://github.com/chaostoolkit/chaostoolkit
```
$ pip install -U chaostoolkit-slack
```
## Slack Token
You can simply generate a [legacy token][legtok]. But you may also create a
full [Slack App][slackapp] and generate a [token from it][slacktok].
[legtok]: https://api.slack.com/custom-integrations/legacy-tokens
[slackapp]: https://api.slack.com/slack-apps
[slacktok]: https://api.slack.com/docs/token-types
## Usage
Currently, this extension only provides notification support to send Chaos
Toolkit events to Slack channels.
To use this extension, edit your [chaostoolkit settings][settings] by adding the
following payload:
[settings]: http://chaostoolkit.org/reference/usage/settings/
```yaml
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:
```yaml
notifications:
-
type: plugin
module: chaosslack.notification
token: xop-1235
channel: general
events:
- run-failed
- run-started
```
Only sends those two events.
## Test
To run the tests for the project execute the following:
```
$ pytest
```
## 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][pep8] code style, sprinkling with tests and submit a PR for
review.
[pep8]: https://pycodestyle.readthedocs.io/en/latest/
The Chaos Toolkit projects require all contributors must sign a
[Developer Certificate of Origin][dco] 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.
[dco]: https://github.com/probot/dco#how-it-works
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
Close
Hashes for chaostoolkit_slack-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d9b51c88d8cb209bf8fe215422c136a1aa6ef6f476b8012abaaff3fbf586c5d3 |
|
MD5 | d1cd62657d34e6f0ec46e0d0094e3ca2 |
|
BLAKE2b-256 | d03da4148f57c6c3e24e502e07cf9bdb0c9e40625f53d88d7f09bae69e1356a5 |