circuitpython-keymanager 1.1.1
Tools to manage notes in musical applications. Includes note priority, arpeggiation, and sequencing.
License: MIT
Keywords: adafruit, blinka, circuitpython, micropython, relic_keymanager, synthesizer, music, keyboard, arpeggiator, sequencer, midi, notes

Introduction
============


.. image:: https://readthedocs.org/projects/circuitpython-keymanager/badge/?version=latest
    :target: https://circuitpython-keymanager.readthedocs.io/
    :alt: Documentation Status



.. image:: https://img.shields.io/discord/327254708534116352.svg
    :target: https://adafru.it/discord
    :alt: Discord


.. image:: https://github.com/relic-se/CircuitPython_KeyManager/workflows/Build%20CI/badge.svg
    :target: https://github.com/relic-se/CircuitPython_KeyManager/actions
    :alt: Build Status


.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
    :target: https://github.com/astral-sh/ruff
    :alt: Code Style: Ruff

Tools to manage notes in musical applications. Includes note priority, arpeggiation, and sequencing.


Dependencies
=============
This driver depends on:

* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_

Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.

Installing from PyPI
=====================
.. note:: This library is not available on PyPI yet. Install documentation is included
   as a standard element. Stay tuned for PyPI availability!

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/circuitpython-keymanager/>`_.
To install for current user:

.. code-block:: shell

    pip3 install circuitpython-keymanager

To install system-wide (this may be required in some cases):

.. code-block:: shell

    sudo pip3 install circuitpython-keymanager

To install in a virtual environment in your current project:

.. code-block:: shell

    mkdir project-name && cd project-name
    python3 -m venv .venv
    source .env/bin/activate
    pip3 install circuitpython-keymanager

Installing to a Connected CircuitPython Device with Circup
==========================================================

Make sure that you have ``circup`` installed in your Python environment.
Install it with the following command if necessary:

.. code-block:: shell

    pip3 install circup

With ``circup`` installed and your CircuitPython device connected use the
following command to install:

.. code-block:: shell

    circup install relic_keymanager

Or the following command to update an existing version:

.. code-block:: shell

    circup update

Usage Example
=============

.. code-block:: python

    from relic_keymanager import Keyboard

    keyboard = Keyboard()

    keyboard.on_voice_press = lambda voice: print(f"Pressed: {voice.note.notenum:d}")
    keyboard.on_voice_release = lambda voice: print(f"Released: {voice.note.notenum:d}")

    for i in range(1, 4):
        keyboard.append(i)
    for i in range(3, 0, -1):
        keyboard.remove(i)

Documentation
=============
API documentation for this library can be found on `Read the Docs <https://circuitpython-keymanager.readthedocs.io/>`_.

For information on building library documentation, please check out
`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.

Contributing
============

Contributions are welcome! Please read our `Code of Conduct
<https://github.com/relic-se/CircuitPython_KeyManager/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.