Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-tca8418/badge/?version=latest
:target: https://docs.circuitpython.org/projects/tca8418/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_TCA8418/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_TCA8418/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
CircuitPython / Python library for TCA8418 Keyboard Multiplexor
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>`_
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>`_.
Works with the TCA8418 keyboard multiplexor.
`Purchase one from the Adafruit shop <http://www.adafruit.com/products/5606>`_
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-tca8418/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-tca8418
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-tca8418
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install adafruit-circuitpython-tca8418
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 adafruit_tca8418
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
See the `examples/` folder for usage examples.
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/tca8418/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_TCA8418/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-tca8418",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, tca8418, python, keyboard, keeb",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/44/6c/5b007e78cdbb479af2cf69754bc078b06a5471438d6870f51da074fe45e2/adafruit-circuitpython-tca8418-1.0.12.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-tca8418/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/tca8418/en/latest/\n :alt: Documentation Status\n\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\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_TCA8418/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_TCA8418/actions\n :alt: Build Status\n\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\nCircuitPython / Python library for TCA8418 Keyboard Multiplexor\n\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\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\nWorks with the TCA8418 keyboard multiplexor.\n\n`Purchase one from the Adafruit shop <http://www.adafruit.com/products/5606>`_\n\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-tca8418/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-tca8418\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-tca8418\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 .env\n source .env/bin/activate\n pip3 install adafruit-circuitpython-tca8418\n\n\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n circup install adafruit_tca8418\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\nSee the `examples/` folder for usage examples.\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/tca8418/en/latest/>`_.\n\nFor information on building library documentation, please check out\n`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_TCA8418/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython / Python library for TCA8418 Keyboard Multiplexor",
"version": "1.0.12",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_TCA8418.git"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" tca8418",
" python",
" keyboard",
" keeb"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "96e69209d676ea6df8174bead8967826085a481718bb9031d193b03d1e962f2b",
"md5": "98a906e55ead72b444d2ad8adc276b00",
"sha256": "d281057b2fae4dff313f4abfd94a7e9bc1e98654536d5d4ca2e214baf43760ba"
},
"downloads": -1,
"filename": "adafruit_circuitpython_tca8418-1.0.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "98a906e55ead72b444d2ad8adc276b00",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7469,
"upload_time": "2024-04-01T14:53:15",
"upload_time_iso_8601": "2024-04-01T14:53:15.684750Z",
"url": "https://files.pythonhosted.org/packages/96/e6/9209d676ea6df8174bead8967826085a481718bb9031d193b03d1e962f2b/adafruit_circuitpython_tca8418-1.0.12-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "446c5b007e78cdbb479af2cf69754bc078b06a5471438d6870f51da074fe45e2",
"md5": "f5d0ac11449b1d8e2726768929afb6c8",
"sha256": "593a297ebb6f1ce2ec664f67cb5910075a0b0a7902480b9354b94907a5383f89"
},
"downloads": -1,
"filename": "adafruit-circuitpython-tca8418-1.0.12.tar.gz",
"has_sig": false,
"md5_digest": "f5d0ac11449b1d8e2726768929afb6c8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30505,
"upload_time": "2024-04-01T14:53:16",
"upload_time_iso_8601": "2024-04-01T14:53:16.697821Z",
"url": "https://files.pythonhosted.org/packages/44/6c/5b007e78cdbb479af2cf69754bc078b06a5471438d6870f51da074fe45e2/adafruit-circuitpython-tca8418-1.0.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-01 14:53:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_TCA8418",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-circuitpython-busdevice",
"specs": []
},
{
"name": "adafruit-circuitpython-register",
"specs": []
}
],
"lcname": "adafruit-circuitpython-tca8418"
}
JSON
