Metadata-Version: 1.0
Name: chroma-feedback
Version: 3.1.0
Summary: Turn your Razer keyboard, mouse or headphone into a extreme feedback device
Home-page: https://github.com/redaxmedia/chroma-feedback
Author: Henry Ruhs
Author-email: info@redaxmedia.com
License: GPL-3.0
Description-Content-Type: UNKNOWN
Description: Chroma Feedback
        ===============
        
            Turn your Razer keyboard, mouse or headphone into a extreme feedback
            device.
        
        |Build Status Travis| |Build Status AppVeyor| |Build Status Circle|
        |PyPI| |License|
        
        Preview
        -------
        
        .. figure:: https://cdn.rawgit.com/redaxmedia/media/master/chroma-feedback/terminal-session.svg
           :alt: Terminal Session
        
           Terminal Session
        
        Installation
        ------------
        
        Install the required OpenRazer driver:
        
        -  `Ubuntu / Linux Mint <https://openrazer.github.io/#ubuntu>`__
        -  `Debian <https://openrazer.github.io/#debian>`__
        -  `Arch Linux <https://openrazer.github.io/#arch>`__
        -  `Fedora <https://openrazer.github.io/#fedora>`__
        -  `openSUSE <https://openrazer.github.io/#opensuse>`__
        -  `Gentoo <https://openrazer.github.io/#gentoo>`__
        
        Install Chroma Feedback using PyPI:
        
        ::
        
            pip install chroma-feedback
        
        Install Chroma Feedback using GitHub:
        
        ::
        
            git clone https://github.com/redaxmedia/chroma-feedback.git
            cd chroma-feedback
            ./setup.py install
        
        Usage
        -----
        
        ::
        
            chroma-feedback [options]
        
            -V, --version
            -P, --provider <provider>
            -H, --host <host>
            -S, --slug <slug>
            -T, --token <token>
            -I, --background-interval <background-interval>
            -B, --background-run
            -D, --dry-run
            -h, --help
        
        Providers
        ---------
        
        +------------+--------+--------+---------+
        | Name       | Host   | Slug   | Token   |
        +============+========+========+=========+
        | AppVeyor   | ✖      | ✔      | ✔       |
        +------------+--------+--------+---------+
        | Circle     | ✖      | ✔      | ✔       |
        +------------+--------+--------+---------+
        | GitLab     | ✔      | ✔      | ✔       |
        +------------+--------+--------+---------+
        | Jenkins    | ✔      | ✔      | ✖       |
        +------------+--------+--------+---------+
        | Travis     | ✖      | ✔      | ✖       |
        +------------+--------+--------+---------+
        
        Examples
        --------
        
        Monitor a single project by slug on AppVeyor:
        
        ::
        
            chroma-feedback --provider=appveyor --slug=redaxmedia/chroma-feedback
        
        Monitor multiple projects by token on AppVeyor:
        
        ::
        
            chroma-feedback --provider=appveyor --token={TOKEN}
        
        Monitor a single project by slug on Circle:
        
        ::
        
            chroma-feedback --provider=circle --slug=github/redaxmedia/chroma-feedback
        
        Monitor multiple projects by token on Circle:
        
        ::
        
            chroma-feedback --provider=circle --token={TOKEN}
        
        Monitor a single project by slug and token on GitLab:
        
        ::
        
            chroma-feedback --provider=gitlab --host={HOST} --slug={SLUG} --token={TOKEN}
        
        Monitor multiple projects by slug and token on GitLab:
        
        ::
        
            chroma-feedback --provider=gitlab --host={HOST} --slug={SLUG} --slug={SLUG} --token={TOKEN}
        
        Monitor a single project by slug on Jenkins:
        
        ::
        
            chroma-feedback --provider=jenkins --host={HOST} --slug={SLUG}
        
        Monitor multiple projects by slug on Jenkins:
        
        ::
        
            chroma-feedback --provider=jenkins --host={HOST} --slug={SLUG} --slug={SLUG}
        
        Monitor a single project by slug on Travis:
        
        ::
        
            chroma-feedback --provider=travis --slug=redaxmedia/chroma-feedback
        
        Monitor multiple projects by user on Travis:
        
        ::
        
            chroma-feedback --provider=travis --slug=redaxmedia
        
        Errors
        ------
        
        +--------------------+---------------+------------------------------------------------------+
        | Message            | Type          | Description                                          |
        +====================+===============+======================================================+
        | Driver not found   | ImportError   | Module ``openrazer.client`` could not be imported    |
        +--------------------+---------------+------------------------------------------------------+
        | Daemon not found   | Exception     | The ``DeviceManager`` throwed a ``DaemonNotFound``   |
        +--------------------+---------------+------------------------------------------------------+
        | Device not found   | General       | There is no supported device connected               |
        +--------------------+---------------+------------------------------------------------------+
        | Data not found     | General       | There is no data available for your request          |
        +--------------------+---------------+------------------------------------------------------+
        
        Indicators
        ----------
        
        +-----------+----------+-----------+
        | Status    | Color    | Effect    |
        +===========+==========+===========+
        | Process   | Yellow   | Static    |
        +-----------+----------+-----------+
        | Passed    | Green    | Static    |
        +-----------+----------+-----------+
        | Errored   | White    | Pulsate   |
        +-----------+----------+-----------+
        | Failed    | Red      | Pulsate   |
        +-----------+----------+-----------+
        
        .. |Build Status Travis| image:: https://img.shields.io/travis/redaxmedia/chroma-feedback.svg
           :target: https://travis-ci.org/redaxmedia/chroma-feedback
        .. |Build Status AppVeyor| image:: https://img.shields.io/appveyor/ci/redaxmedia/chroma-feedback.svg
           :target: https://ci.appveyor.com/project/redaxmedia/chroma-feedback
        .. |Build Status Circle| image:: https://img.shields.io/circleci/project/github/redaxmedia/chroma-feedback.svg
           :target: https://circleci.com/gh/redaxmedia/chroma-feedback
        .. |PyPI| image:: https://img.shields.io/pypi/v/chroma-feedback.svg
           :target: https://pypi.org/project/chroma-feedback
        .. |License| image:: https://img.shields.io/pypi/l/chroma-feedback.svg
           :target: https://pypi.org/project/chroma-feedback
        
Keywords: razer chroma appveyor circle gitlab jenkins travis ci
Platform: UNKNOWN
