adafruit-circuitpython-neokey


Nameadafruit-circuitpython-neokey JSON
Version 1.1.3 PyPI version JSON
download
home_pageNone
SummaryCircuitPython library for using Adafruit NeoKey.
upload_time2024-10-07 22:32:42
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseMIT
keywords adafruit neokey neopixel mechanical keyboard led rgbsensor hardware micropython circuitpython
VCS
bugtrack_url
requirements Adafruit-Blinka adafruit-circuitpython-seesaw
Travis-CI No Travis.
coveralls test coverage No coveralls.
            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/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
    :alt: Code Style: Black

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/37/9a/1a583f90bbc60f602867b496bee7b300b9c90cc8021770d23adaa680a593/adafruit_circuitpython_neokey-1.1.3.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/badge/code%20style-black-000000.svg\n    :target: https://github.com/psf/black\n    :alt: Code Style: Black\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.3",
    "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": "",
            "digests": {
                "blake2b_256": "209c88709f06d2d1355df2a1f5b0113eb42b01fadfd7857a0ea71fcd8a3f2d82",
                "md5": "d0e94ad0274e5472d26a2eb60b157d23",
                "sha256": "90fef42ee8bf5df4da3108859429fb7e26f41b05efb5a9be1f119ed0d7730a5b"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_neokey-1.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d0e94ad0274e5472d26a2eb60b157d23",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 4741,
            "upload_time": "2024-10-07T22:32:41",
            "upload_time_iso_8601": "2024-10-07T22:32:41.806081Z",
            "url": "https://files.pythonhosted.org/packages/20/9c/88709f06d2d1355df2a1f5b0113eb42b01fadfd7857a0ea71fcd8a3f2d82/adafruit_circuitpython_neokey-1.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "379a1a583f90bbc60f602867b496bee7b300b9c90cc8021770d23adaa680a593",
                "md5": "4592de2ba81d12b656f36fcca6aced1e",
                "sha256": "818c5c92957a75c07312ba38381f3f064acefca3fc281e2af7b77f478ae99c6d"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_neokey-1.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "4592de2ba81d12b656f36fcca6aced1e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 26319,
            "upload_time": "2024-10-07T22:32:42",
            "upload_time_iso_8601": "2024-10-07T22:32:42.634960Z",
            "url": "https://files.pythonhosted.org/packages/37/9a/1a583f90bbc60f602867b496bee7b300b9c90cc8021770d23adaa680a593/adafruit_circuitpython_neokey-1.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-07 22:32:42",
    "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"
}
        
Elapsed time: 0.41303s