Metadata-Version: 1.2
Name: pyvkb
Version: 0.1.0
Summary: Python library for controlling VKB devices
Home-page: https://github.com/ventrovar/pyvkb
Author: Ventorvar
Author-email: ventorvar@gmail.com
License: MIT license
Description: =====
        pyvkb
        =====
        
        
        .. image:: https://img.shields.io/pypi/v/pyvkb.svg
                :target: https://pypi.python.org/pypi/pyvkb
        
        .. image:: https://img.shields.io/travis/ventorvar/pyvkb.svg
                :target: https://travis-ci.org/ventorvar/pyvkb
        
        .. image:: https://readthedocs.org/projects/pyvkb/badge/?version=latest
                :target: https://pyvkb.readthedocs.io/en/latest/?badge=latest
                :alt: Documentation Status
        
        .. image:: https://coveralls.io/repos/github/ventorvar/pyvkb/badge.svg?branch=devel
                :target: https://coveralls.io/github/ventorvar/pyvkb?branch=devel
        
        .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
            :target: https://github.com/psf/black
        
        
        Python library for controlling VKB devices
        
        
        * Free software: MIT license
        * Documentation: https://pyvkb.readthedocs.io.
        
        .. warning::
            pyvkb is in very early stages of development, things are likely to change.
        
        .. warning::
            Currently pyvkb only works on Windows.
        
        .. warning::
            The techniques used are the same that the VKBDevCfg tools use. Every effort is made to ensure
            that nothing will harm the device. Even though, use at your own risk.
        
        
        Features
        --------
        
        * CLI
        * List connected VKB devices
        * Get and set custom LED configurations
        
        
        CLI
        ---
        
        See `vkb --help` for more information
        
        .. code-block::
        
            $ pip install pyvkb
            $ vkb list
              0:  VKB-Sim Gladiator K  (4d1e55b2-f16f-11cf-88cb-001111000030)
            $ vkb led show
             0:  VKB-Sim Gladiator K  (4d1e55b2-f16f-11cf-88cb-001111000030)
             ----------------------------------------------------------------------
             led:10 clm:COLOR1 lem:OFF color1:#000000 color2:#000000
             led:11 clm:COLOR1 lem:OFF color1:#000000 color2:#000000
             led: 0 clm:COLOR1 lem:OFF color1:#000000 color2:#000000
        
            $ vkb led set --device 0 --leds 10 --color1 "#f00" --led-mode=1
            $ vkb led show
             0:  VKB-Sim Gladiator K  (4d1e55b2-f16f-11cf-88cb-001111000030)
             ----------------------------------------------------------------------
             led:10 clm:COLOR1 lem:CONSTANT color1:#ff0000 color2:#000000
             led:11 clm:COLOR1 lem:OFF color1:#000000 color2:#000000
             led: 0 clm:COLOR1 lem:OFF color1:#000000 color2:#000000
        
        
        =======
        History
        =======
        
        0.1.0 (2020-06-15)
        ------------------
        
        * First release on PyPI.
        
Keywords: pyvkb
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.5
