OpenRGB Python Client

You are currently better off using jath03's Python client! They've been putting a ton of work into it and its generally a easier library to use.

OpenRGB dropped it's server protocol into master recently, so I wrote this hacky little client library to use it.

You can find the documentation here, and install it by:

pip install openrgb-pyclient

note This is subject to change as the library is still early in development. I do intend to make cleaner abstractions at some point, but for now it's fairly low level. The examples folder should contain enough code to get started, but you'll end up having to read the source if you want to do anything more complex.

Development

If you would like to run this from git, you can do the following:

git clone https://github.com/bahorn/OpenRGB-PyClient.git
cd OpenRGB-PyClient
virtualenv -p python3 .venv
source .venv/bin/activate
pip install -r requirements.txt

And you can now start running scripts in examples like so:

python examples/color-change.py

Projects Using This!

• OpenRGB-DBus-Connector by @vinno97

Alternatives

This isn't the only library for OpenRGBs SDK manager! You might find one of these more suitable for your project!

• NetworkClient.{cpp,h} The C++ client in the OpenRGB repo.
• vlakreeh's NodeJS client
• jath03's Python client
• diogotr7's C# Client