Introduction
============
.. image:: https://readthedocs.org/projects/circuitpython-softkeyboard/badge/?version=latest
:target: https://circuitpython-softkeyboard.readthedocs.io/
:alt: Documentation Status
.. image:: https://img.shields.io/discord/327254708534116352.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/Foamyguy/CircuitPython_SoftKeyboard/workflows/Build%20CI/badge.svg
:target: https://github.com/Foamyguy/CircuitPython_SoftKeyboard/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 software defined keyboard for touch displays using displayio GridLayout.
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
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/circuitpython-softkeyboard/>`_.
To install for current user:
.. code-block:: shell
pip3 install circuitpython-softkeyboard
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install circuitpython-softkeyboard
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-softkeyboard
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 softkeyboard
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
`Simpletest Example <https://github.com/FoamyGuy/CircuitPython_SoftKeyboard/examples/softkeyboard_simpletest.py>`_
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://circuitpython-softkeyboard.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/Foamyguy/CircuitPython_SoftKeyboard/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "circuitpython-softkeyboard",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,softkeyboard,keyboard,softkeyboard,touchscreen,displayio,display,ui,gui,qwerty",
"author": "",
"author_email": "\"Tim Cocks, DJDevon3\" <foamyguy@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/44/31/be6e12a2d069e292287456096ae46578f1d4fa9b9ce8037d5aacbaa1bfd7/circuitpython-softkeyboard-1.0.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/circuitpython-softkeyboard/badge/?version=latest\n :target: https://circuitpython-softkeyboard.readthedocs.io/\n :alt: Documentation Status\n\n\n\n.. image:: https://img.shields.io/discord/327254708534116352.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n\n.. image:: https://github.com/Foamyguy/CircuitPython_SoftKeyboard/workflows/Build%20CI/badge.svg\n :target: https://github.com/Foamyguy/CircuitPython_SoftKeyboard/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 software defined keyboard for touch displays using displayio GridLayout.\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\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\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/circuitpython-softkeyboard/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install circuitpython-softkeyboard\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install circuitpython-softkeyboard\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 .env/bin/activate\n pip3 install circuitpython-softkeyboard\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 softkeyboard\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\n`Simpletest Example <https://github.com/FoamyGuy/CircuitPython_SoftKeyboard/examples/softkeyboard_simpletest.py>`_\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://circuitpython-softkeyboard.readthedocs.io/>`_.\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/Foamyguy/CircuitPython_SoftKeyboard/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython software defined keyboard for touch displays using displayio GridLayout.",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/Foamyguy/CircuitPython_SoftKeyboard"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"softkeyboard",
"keyboard",
"softkeyboard",
"touchscreen",
"displayio",
"display",
"ui",
"gui",
"qwerty"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e4687e2fcbcf3944ec33733ba8bccdd64ff522ba54eec2870676b9fe6ef89fb8",
"md5": "f46e116d9763c7f4c02cd9b18069fb78",
"sha256": "66d7268ac240cf897ba8b27e302e0ac935541f31713423fc7cd5d26676589779"
},
"downloads": -1,
"filename": "circuitpython_softkeyboard-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f46e116d9763c7f4c02cd9b18069fb78",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7953,
"upload_time": "2024-01-27T17:15:27",
"upload_time_iso_8601": "2024-01-27T17:15:27.341851Z",
"url": "https://files.pythonhosted.org/packages/e4/68/7e2fcbcf3944ec33733ba8bccdd64ff522ba54eec2870676b9fe6ef89fb8/circuitpython_softkeyboard-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4431be6e12a2d069e292287456096ae46578f1d4fa9b9ce8037d5aacbaa1bfd7",
"md5": "8e0bb30aa41dfe011dc1afabdde253a4",
"sha256": "da4851c275a25eb55a419f60b4d08521fd4199e7dc4c05d31e58f334d6d9d1e2"
},
"downloads": -1,
"filename": "circuitpython-softkeyboard-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "8e0bb30aa41dfe011dc1afabdde253a4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 29745,
"upload_time": "2024-01-27T17:15:29",
"upload_time_iso_8601": "2024-01-27T17:15:29.240530Z",
"url": "https://files.pythonhosted.org/packages/44/31/be6e12a2d069e292287456096ae46578f1d4fa9b9ce8037d5aacbaa1bfd7/circuitpython-softkeyboard-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-27 17:15:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Foamyguy",
"github_project": "CircuitPython_SoftKeyboard",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "circuitpython-softkeyboard"
}
JSON
