Introduction
============
.. image:: https://readthedocs.org/projects/circuitpython-lilygo-t-deck/badge/?version=latest
:target: https://circuitpython-lilygo-t-deck.readthedocs.io/
:alt: Documentation Status
.. image:: https://img.shields.io/discord/327254708534116352.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/rgrizzell/CircuitPython_LILYGO_T-Deck/workflows/Build%20CI/badge.svg
:target: https://github.com/rgrizzell/CircuitPython_LILYGO_T-Deck/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 drivers for the LILYGO T-Deck peripherals.
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-lilygo-t-deck/>`_.
To install for current user:
.. code-block:: shell
pip3 install circuitpython-lilygo-t-deck
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install circuitpython-lilygo-t-deck
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-lilygo-t-deck
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 lilygo_tdeck
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
.. code-block:: python
import time
from lilygo_tdeck import TDeck
t = TDeck()
while True:
keypress = t.get_keypress()
if keypress:
print(keypress)
time.sleep(0.1)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://circuitpython-lilygo-t-deck.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/rgrizzell/CircuitPython_LILYGO_T-Deck/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "circuitpython-lilygo-t-deck",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,lilygo-tdeck,lilygo,t-deck",
"author": "",
"author_email": "Robert Grizzell <robert@grizzell.me>",
"download_url": "https://files.pythonhosted.org/packages/64/fe/e2ca66bc139e4dd7dd4ae5b2e7d6cb240b09ca05b88ed7bc46e22abe37d6/circuitpython-lilygo-t-deck-0.1.1.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/circuitpython-lilygo-t-deck/badge/?version=latest\n :target: https://circuitpython-lilygo-t-deck.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/rgrizzell/CircuitPython_LILYGO_T-Deck/workflows/Build%20CI/badge.svg\n :target: https://github.com/rgrizzell/CircuitPython_LILYGO_T-Deck/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 drivers for the LILYGO T-Deck peripherals.\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-lilygo-t-deck/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install circuitpython-lilygo-t-deck\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install circuitpython-lilygo-t-deck\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-lilygo-t-deck\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 lilygo_tdeck\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.. code-block:: python\n\n import time\n from lilygo_tdeck import TDeck\n\n t = TDeck()\n\n while True:\n keypress = t.get_keypress()\n if keypress:\n print(keypress)\n time.sleep(0.1)\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://circuitpython-lilygo-t-deck.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/rgrizzell/CircuitPython_LILYGO_T-Deck/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython drivers for the LILYGO T-Deck peripherals.",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/rgrizzell/CircuitPython_LILYGO_T-Deck"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"lilygo-tdeck",
"lilygo",
"t-deck"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e4798cbbd573ca8d91270f194a3afe31ab9ffd30480c10035641da0755f5a569",
"md5": "0bfc7b77a2de6089a9ef1ad1486cdc73",
"sha256": "2376870e89d3f9fb165c70587f21717d33154cee5257945def2b74f5b7f24357"
},
"downloads": -1,
"filename": "circuitpython_lilygo_t_deck-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0bfc7b77a2de6089a9ef1ad1486cdc73",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5814,
"upload_time": "2023-12-07T04:56:50",
"upload_time_iso_8601": "2023-12-07T04:56:50.946591Z",
"url": "https://files.pythonhosted.org/packages/e4/79/8cbbd573ca8d91270f194a3afe31ab9ffd30480c10035641da0755f5a569/circuitpython_lilygo_t_deck-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "64fee2ca66bc139e4dd7dd4ae5b2e7d6cb240b09ca05b88ed7bc46e22abe37d6",
"md5": "4ae8b7da3349ba2a42940ebb5791d732",
"sha256": "9b9c4dbfab043b756e417cdda19720585e2ea95d167dd69523cfb7cb5f645956"
},
"downloads": -1,
"filename": "circuitpython-lilygo-t-deck-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "4ae8b7da3349ba2a42940ebb5791d732",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 28223,
"upload_time": "2023-12-07T04:56:52",
"upload_time_iso_8601": "2023-12-07T04:56:52.698070Z",
"url": "https://files.pythonhosted.org/packages/64/fe/e2ca66bc139e4dd7dd4ae5b2e7d6cb240b09ca05b88ed7bc46e22abe37d6/circuitpython-lilygo-t-deck-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-07 04:56:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rgrizzell",
"github_project": "CircuitPython_LILYGO_T-Deck",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
}
],
"lcname": "circuitpython-lilygo-t-deck"
}
JSON
