Metadata-Version: 2.1
Name: chaostoolkit-slack
Version: 0.3.0
Summary: Chaos Toolkit Extension for Slack
Home-page: http://chaostoolkit.org
Author: chaostoolkit Team
Author-email: contact@chaostoolkit.org
License: Apache License Version 2.0
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.6+
        
        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]: https://docs.chaostoolkit.org/reference/usage/cli/#configure-the-chaos-toolkit
        
        ```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.
        
        ## 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, add appropriate 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
        
        ### Develop
        
        If you wish to develop on this project, make sure to install the development
        dependencies. But first, [create a virtual environment][venv] and then install
        those dependencies.
        
        [venv]: https://docs.chaostoolkit.org/reference/usage/install/#create-a-virtual-environment
        
        ```console
        $ pip install -r requirements-dev.txt -r requirements.txt
        ```
        
        Then, point your environment to this directory:
        
        ```console
        $ 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
        ```
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: Freely Distributable
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Python: >=3.6.*
Description-Content-Type: text/markdown
