Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/chroma-sdk/chroma-python

Python library for the Razer Chroma REST API
https://github.com/chroma-sdk/chroma-python

chroma python python-library razer

Last synced: 3 months ago
JSON representation

Python library for the Razer Chroma REST API

Awesome Lists containing this project

README

        

# ChromaPython

[![Build status](https://ci.appveyor.com/api/projects/status/5ihmbuppv3g29or2/branch/master?svg=true)](https://ci.appveyor.com/project/Vaypron/chroma-python-ee89l/branch/master)

## Disclaimer
This project is mostly abandoned!

## Support

### Devices
```
Keyboard
Headset
Mouse
Headset
Keypad
ChromaLink
```

### BCA
#### Read
```
Keyboard
```
#### Write
```
.
```

## How to install

### Auto-Install with pip

```
Coming soon.
```

### Install with pip (currently recommended)

1. Clone the repository
2. Navigate into the directory and run:
```
pip install .
```

Pip should now install all necessary dependencies, as well as ChromaPython itself.

### By using the Source files:

Requirements:
```
requests
```
Can be installed by
```
pip install requests
```

After installing requests, clone the repository and copy all files of the ChromaPython folder into your working directory.

## Contributing
Feel free to contribute by reporting issues and/or extending the current code. You can do this by forking this project
and creating a pull request. Unfinished tasks can be found as "enhancement" issues.
Also, please always add comments to your changes/new code.

## How to use

Take a look at ```Tests\checkall.py```. It should give you a good example on how to use it.
An example on how to use the BCA feature can be found in```Test\checkBinary.py```.