semvec/pypi-packages huggingface dataset:
rgbmon 0.1.0
System monitoring tool that colors your hardware
Requires Python: >=3.7

# RGBmon

[![PyPI Status](https://badge.fury.io/py/rgbmon.svg)](https://badge.fury.io/py/rgbmon)
[![Build Status](https://travis-ci.com/inlart/RGBmon.svg?branch=master)](https://travis-ci.com/inlart/RGBmon)
[![Documentation Status](https://readthedocs.org/projects/rgbmon/badge/?version=latest)](https://rgbmon.readthedocs.io/en/latest/?badge=latest)

RGBmon is a system monitoring tool that lights up your components to indicate system status.

**Note:**
Only use modes on devices that can handle frequent color updates. If the device supports such updates they are often refered to as *direct* mode.

## Installation

* Install and set up [OpenRGB](https://gitlab.com/CalcProgrammer1/OpenRGB/-/blob/master/README.md)
* `pip install --user rgbmon`

## Usage

* Start the OpenRGB SDK server
* Run RGBmon `rgbmon-cli --config=path/to/config.json`

RGBmon always needs a path to a valid configuration in the json format.
The project provides sample configurations in the `examples/` directory which you can try.
If you want to create your own configuration file please have a look at the [documentation](https://rgbmon.readthedocs.io/en/latest/).

## Dependencies

* Python >=3.7
* [OpenRGB](https://gitlab.com/CalcProgrammer1/OpenRGB)
* [openrgb-python](https://github.com/jath03/openrgb-python)
leza-typewriter 1.0.0
function for printing text in a type writer manner

**Module: typewriter**

This module provides a function that prints out text in a typewriter manner

    def typing(txt, text_speed=0.05):

        for char in txt:
            sys.stdout.write(char)
            sys.stdout.flush()

            if char != "\n":
                time.sleep(text_speed)

            else:
                time.sleep(text_speed + 0.3)

        else:
            sys.stdout.write("\n")

- text: Argument that will be printing to the terminal
- text_speed: Specifies the time taken to pause after printing each character