Skip to main content

Turn your RGB powered hardware into an build indicator for continuous integration

Project description

Chroma Feedback

Turn your RGB powered hardware into an build indicator for continuous integration.

Build Status Coverage Status PyPI License

Preview

Terminal Session

Installation

Install Chroma Feedback:

apt-get install libusb-1.0-0-dev libudev-dev
pip3 install chroma-feedback

Install openrazer-meta for Razer Chroma:

add-apt-repository ppa:openrazer/stable
apt-get update
apt install openrazer-meta

Usage

Combine producers and consumers as needed:

chroma-feedback [options]

-V, --version
-P, --producer <producer>
-C, --consumer <consumer>
-I, --background-interval <background-interval>
-B, --background-run
-D, --dry-run
-h, --help

Producers

AppVeyor

Name Default Mandatory
Host https://ci.appveyor.com optional
Slug optional
Token optional

Monitor a single build:

chroma-feedback --producer=appveyor

--appveyor-slug <username/repository>

Monitor multiple builds:

chroma-feedback --producer=appveyor

--appveyor-token <token>

Bamboo

Name Mandatory
Host required
Slug required
Token required

Monitor a single build:

chroma-feedback --producer=bamboo

--bamboo-host <host>
--bamboo-slug <plan>
--bamboo-token <token>

Monitor multiple builds:

chroma-feedback --producer=bamboo

--bamboo-host <host>
--bamboo-slug <project>
--bamboo-token <token>

Circle

Name Default Mandatory
Host https://circleci.com optional
Slug optional
Token optional

Monitor a single build:

chroma-feedback --producer=circle

--circle-slug <username/repository>

Monitor multiple builds:

chroma-feedback --producer=circle

--circle-token <token>

Codeship

Name Default Mandatory
Host https://api.codeship.com optional
Slug optional
Username required
Password required

Monitor a single build:

chroma-feedback --producer=codeship

--codeship-slug <project-id>
--codeship-username <username>
--codeship-password <password>

Monitor multiple builds:

chroma-feedback --producer=codeship

--codeship-username <username>
--codeship-password <password>

Custom

Name Mandatory
Host required
Slug required

Monitor a single build:

chroma-feedback --producer=custom

--custom-host <host>
--custom-slug <slug>

Monitor multiple builds:

chroma-feedback --producer=custom

--custom-host <host>
--custom-slug <slug>
--custom-slug <slug>

Example for {host}/statuses/{slug} endpoint:

[
	{
		"slug": "chroma-feedback",
		"active": true,
		"status": "passed"
	}
]

GitHub

Name Default Mandatory
Host https://api.github.com optional
Slug required
Username required
Token required

Monitor a single build:

chroma-feedback --producer=github

--github-slug <username/repository>
--github-username <username>
--github-token <token>

Monitor multiple builds:

chroma-feedback --producer=github

--github-slug <username/repository>
--github-slug <username/repository>
--github-username <username>
--github-token <token>

GitLab

Name Default Mandatory
Host https://gitlab.com optional
Slug required
Token required

Monitor a single build:

chroma-feedback --producer=gitlab

--gitlab-slug <project-id>
--gitlab-token <token>

Monitor multiple builds:

chroma-feedback --producer=gitlab

--gitlab-slug <project-id>
--gitlab-slug <project-id>
--gitlab-token <token>

Jenkins

Name Mandatory
Host required
Slug required
Username optional
Password optional

Monitor a single build:

chroma-feedback --producer=jenkins

--jenkins-host <host>
--jenkins-slug <job>
--jenkins-username <username>
--jenkins-password <password>

Monitor multiple builds:

chroma-feedback --producer=jenkins

--jenkins-host <host>
--jenkins-slug <job>
--jenkins-slug <job>
--jenkins-username <username>
--jenkins-password <password>

TeamCity

Name Default Mandatory
Host https://teamcity.jetbrains.com optional
Slug optional
Token required

Monitor a single build:

chroma-feedback --producer=teamcity

--teamcity-slug <project-id>
--teamcity-token <token>

Monitor multiple builds:

chroma-feedback --producer=teamcity

--teamcity-token <token>

Travis

Name Default Mandatory
Host https://api.travis-ci.org optional
Slug required

Monitor a single build:

chroma-feedback --producer=travis

--travis-slug <username/repository>

Monitor multiple builds:

chroma-feedback --producer=travis

--travis-slug <username>

Wercker

Name Default Mandatory
Host https://app.wercker.com optional
Slug required
Token required

Monitor a single build:

chroma-feedback --producer=wercker

--wercker-slug <username/application>
--wercker-token <token>

Monitor multiple builds:

chroma-feedback --producer=wercker

--wercker-slug <<username/application>
--wercker-slug <<username/application>
--wercker-token <token>

Consumers

Agile Innovative BlinkStick

Name Mandatory
Device optional

Indicate status via devices:

chroma-feedback --consumer=agile_innovative_blinkstick

--agile-innovative-blinkstick-device <device-serial>

Lifx Light

Name Mandatory
Light optional
Group optional

Indicate status via lights:

chroma-feedback --consumer=lifx_light

--lifx-light-light <light-name>

Indicate status via groups:

chroma-feedback --consumer=lifx_light

--lifx-light-group <group-name>

Magic Hue

Name Mandatory
IP optional

Indicate status via lights:

chroma-feedback --consumer=magic_hue

Philips Hue

Name Mandatory
IP optional
Light optional
Group optional

Indicate status via lights:

chroma-feedback --consumer=philips_hue

--philips-hue-light <light-name>

Indicate status via groups:

chroma-feedback --consumer=philips_hue

--philips-hue-group <group-name>

Razer Chroma

Name Mandatory
Device optional

Indicate status via devices:

chroma-feedback --consumer=razer_chroma

--razer-chrome-device <device-name>

ThingM Blink

Name Mandatory
Device optional

Indicate status via devices:

chroma-feedback --consumer=thingm_blink

--thingm-blink-device <device-serial>

Xiaomi Yeelight

Name Mandatory
IP optional

Indicate status via lights:

chroma-feedback --consumer=xiaomi_yeelight

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

chroma-feedback-7.5.3.tar.gz (18.1 kB view details)

Uploaded Source

File details

Details for the file chroma-feedback-7.5.3.tar.gz.

File metadata

  • Download URL: chroma-feedback-7.5.3.tar.gz
  • Upload date:
  • Size: 18.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.53.0 CPython/3.8.5

File hashes

Hashes for chroma-feedback-7.5.3.tar.gz
Algorithm Hash digest
SHA256 b35e3ccc39ed60fd51367163f9bc351ac2c35dc5d4d7b504c776ab19bc74a423
MD5 af6f775058e4481d8cbd0432149b970d
BLAKE2b-256 a7ab55769950d3b5dbe88ef1769726653e68889e14a50f9b7433bcfbb89fe232

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page