Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-neokey/badge/?version=latest
:target: https://docs.circuitpython.org/projects/neokey/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_NeoKey/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_NeoKey/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
This is a library for using the Adafruit NeoKey boards with circuitpython.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_
* `Adafruit Seesaw <https://github.com/adafruit/Adafruit_CircuitPython_seesaw>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
Installing from PyPI
====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-neokey/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-neokey
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-neokey
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-neokey
Usage Example
=============
see examples/neokey1x4_simpletest.py for usage example
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/neokey/en/latest/>`_.
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/adafruit/Adafruit_CircuitPython_NeoKey/blob/master/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-neokey",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, neokey, neopixel, mechanical, keyboard, led, rgbsensor, hardware, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/cb/ac/8e7ff709a6a2a535e14d1d1053dde8b474485efc2c6613b4a1b7dd2af155/adafruit_circuitpython_neokey-1.1.7.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-neokey/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/neokey/en/latest/\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_NeoKey/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_NeoKey/actions/\n :alt: Build Status\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n :target: https://github.com/astral-sh/ruff\n :alt: Code Style: Ruff\n\nThis is a library for using the Adafruit NeoKey boards with circuitpython.\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\n* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_\n* `Adafruit Seesaw <https://github.com/adafruit/Adafruit_CircuitPython_seesaw>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-neokey/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-neokey\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-neokey\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .venv/bin/activate\n pip3 install adafruit-circuitpython-neokey\n\nUsage Example\n=============\n\nsee examples/neokey1x4_simpletest.py for usage example\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/neokey/en/latest/>`_.\n\nFor 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>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_NeoKey/blob/master/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for using Adafruit NeoKey.",
"version": "1.1.7",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_NeoKey"
},
"split_keywords": [
"adafruit",
" neokey",
" neopixel",
" mechanical",
" keyboard",
" led",
" rgbsensor",
" hardware",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "e8d6a747ded3855fc7d8176c58ee1c221e6af5769482b291df96a01739842861",
"md5": "869b2401cbf97828c3702dd3016e0528",
"sha256": "cec098b762df08773994465de5abb5b645e4dcedf070d36e27fda5547efb5cd3"
},
"downloads": -1,
"filename": "adafruit_circuitpython_neokey-1.1.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "869b2401cbf97828c3702dd3016e0528",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4777,
"upload_time": "2025-10-20T20:44:26",
"upload_time_iso_8601": "2025-10-20T20:44:26.873722Z",
"url": "https://files.pythonhosted.org/packages/e8/d6/a747ded3855fc7d8176c58ee1c221e6af5769482b291df96a01739842861/adafruit_circuitpython_neokey-1.1.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "cbac8e7ff709a6a2a535e14d1d1053dde8b474485efc2c6613b4a1b7dd2af155",
"md5": "4eb14761e017e690d278351c9a0a4b5f",
"sha256": "815e6be94b6c8673214bcb9c09ee50c9617adea77772e198adce87a3ac942d10"
},
"downloads": -1,
"filename": "adafruit_circuitpython_neokey-1.1.7.tar.gz",
"has_sig": false,
"md5_digest": "4eb14761e017e690d278351c9a0a4b5f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 23094,
"upload_time": "2025-10-20T20:44:27",
"upload_time_iso_8601": "2025-10-20T20:44:27.662227Z",
"url": "https://files.pythonhosted.org/packages/cb/ac/8e7ff709a6a2a535e14d1d1053dde8b474485efc2c6613b4a1b7dd2af155/adafruit_circuitpython_neokey-1.1.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-20 20:44:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_NeoKey",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-circuitpython-seesaw",
"specs": []
}
],
"lcname": "adafruit-circuitpython-neokey"
}
JSON
