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:

pip3 install chroma-feedback

Install the dependencies for Linux:

apt-get install libusb-1.0-0-dev libudev-dev
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 required

Monitor a single build:

chroma-feedback --producer=appveyor

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

Monitor multiple builds:

chroma-feedback --producer=appveyor

--appveyor-token <token>

Azure

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

Monitor a single build:

chroma-feedback --producer=azure

--azure-slug <organization/project>
--azure-token <token>

Monitor multiple builds:

chroma-feedback --producer=azure

--azure-slug <organization/project>
--azure-slug <organization/project>
--azure-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>

Bitbucket

Name Default Mandatory
Host https://api.bitbucket.org optional
Slug required
Username required
Password required

Monitor a single build:

chroma-feedback --producer=bitbucket

--bitbucket-slug <username/repository>
--bitbucket-username <username>
--bitbucket-password <password>

Monitor multiple builds:

chroma-feedback --producer=bitbucket

--bitbucket-slug <username/repository>
--bitbucket-slug <username/repository>
--bitbucket-username <username>
--bitbucket-password <password>

Buddy

Name Default Mandatory
Host https://api.buddy.works optional
Slug required
Token required

Monitor a single build:

chroma-feedback --producer=buddy

--buddy-slug <workspace/project>
--buddy-token <token>

Monitor multiple builds:

chroma-feedback --producer=buddy

--buddy-slug <workspace>
--buddy-token <token>

Circle

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

Monitor a single build:

chroma-feedback --producer=circle

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

Monitor multiple builds with mine filter:

chroma-feedback --producer=circle
--circle-slug <username/repository>
--circle-slug <username/repository>
--circle-filter=mine
--circle-token <token>

Monitor multiple builds:

chroma-feedback --producer=circle

--circle-organization <organization>
--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 <username/repository>
--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
Token required

Monitor a single build:

chroma-feedback --producer=github

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

Monitor multiple builds:

chroma-feedback --producer=github

--github-slug <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 required
Password required

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.com optional
Slug required
Token required

Monitor a single build:

chroma-feedback --producer=travis

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

Monitor multiple builds:

chroma-feedback --producer=travis

--travis-slug <username>
--travis-token <token>

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>
--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>

Embrava Blynclight

Name Mandatory
Device optional

Indicate status via devices:

chroma-feedback --consumer=embrava_blynclight

--embrava-blynclight-device <device-name>

Kuando Busylight

Name Mandatory
Device optional

Indicate status via devices:

chroma-feedback --consumer=kuando_busylight

--kuando-busylight-device <device-name>

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>

Luxafor Flag

Name Mandatory
Device optional

Indicate status via devices:

chroma-feedback --consumer=luxafor_flag

--luxafor-flag-device <device-name>

Magic Hue

Name Mandatory
IP optional

Indicate status via lights:

chroma-feedback --consumer=magic_hue

--magic-hue-ip <light-ip>

Nanoleaf Light

Name Mandatory
IP optional

Indicate status via lights:

chroma-feedback --consumer=nanoleaf_light

--nanoleaf-light-ip <light-ip>

Philips Hue

Name Mandatory
IP optional
Light optional
Group optional

Indicate status via lights:

chroma-feedback --consumer=philips_hue

--philips-hue-ip <bridge-ip>
--philips-hue-light <light-name>

Indicate status via groups:

chroma-feedback --consumer=philips_hue

--philips-hue-ip <bridge-ip>
--philips-hue-group <group-name>

Razer Chroma

Name Mandatory
Device optional

Indicate status via devices:

chroma-feedback --consumer=razer_chroma

--razer-chroma-device <device-name>

ThingM Blink1

Name Mandatory
Device optional

Indicate status via devices:

chroma-feedback --consumer=thingm_blink1

--thingm-blink1-device <device-serial>

WiZ Light

Name Mandatory
IP optional

Indicate status via lights:

chroma-feedback --consumer=wiz_light

--wiz-light-ip <light-ip>

Xiaomi Yeelight

Name Mandatory
IP optional

Indicate status via lights:

chroma-feedback --consumer=xiaomi_yeelight

--xiaomi-yeelight-ip <light-ip>

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-10.1.0.tar.gz (24.2 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: chroma-feedback-10.1.0.tar.gz
  • Upload date:
  • Size: 24.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.4.2 requests/2.25.1 setuptools/57.0.0 requests-toolbelt/0.8.0 tqdm/4.30.0 CPython/3.8.5

File hashes

Hashes for chroma-feedback-10.1.0.tar.gz
Algorithm Hash digest
SHA256 24cb72ba216f5bde3cfa87f4d656f67b343762c04ed09d81f33ea84aa40bad8f
MD5 0fd7aafd7f5546701bec2287cd0a8ad7
BLAKE2b-256 f9aca6757c23e83d0364df3916c85359001f60b38ee882ee835ccf6e00b9252d

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