Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-display-button/badge/?version=latest
:target: https://docs.circuitpython.org/projects/display-button/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_Display_Button/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_Display_Button/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
UI Buttons for displayio
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://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-display-button/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-display-button
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-display-button
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-display-button
Usage Example
=============
See examples in examples/ folder.
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/display-button/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_Display_Button/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Building locally
================
Zip release files
-----------------
To build this library locally you'll need to install the
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
.. code-block:: shell
python3 -m venv .venv
source .venv/bin/activate
pip install circuitpython-build-tools
Once installed, make sure you are in the virtual environment:
.. code-block:: shell
source .venv/bin/activate
Then run the build:
.. code-block:: shell
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-display_button --library_location .
Sphinx documentation
-----------------------
Sphinx is used to build the documentation based on rST files and comments in the code. First,
install dependencies (feel free to reuse the virtual environment from above):
.. code-block:: shell
python3 -m venv .venv
source .venv/bin/activate
pip install Sphinx sphinx-rtd-theme
Now, once you have the virtual environment activated:
.. code-block:: shell
cd docs
sphinx-build -E -W -b html . _build/html
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
locally verify it will pass.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-display-button",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, display_button, buttons, UI",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/21/69/1bdcbe8b7c282b1cab1ac3446399c9182003708d51a131ec09736b1543e7/adafruit_circuitpython_display_button-1.11.2.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-display-button/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/display-button/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_Display_Button/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_Display_Button/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\nUI Buttons for displayio\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://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n--------------------\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-display-button/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-display-button\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-display-button\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-display-button\n\nUsage Example\n=============\n\nSee examples in examples/ folder.\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/display-button/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_Display_Button/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n\nBuilding locally\n================\n\nZip release files\n-----------------\n\nTo build this library locally you'll need to install the\n`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.\n\n.. code-block:: shell\n\n python3 -m venv .venv\n source .venv/bin/activate\n pip install circuitpython-build-tools\n\nOnce installed, make sure you are in the virtual environment:\n\n.. code-block:: shell\n\n source .venv/bin/activate\n\nThen run the build:\n\n.. code-block:: shell\n\n circuitpython-build-bundles --filename_prefix adafruit-circuitpython-display_button --library_location .\n\nSphinx documentation\n-----------------------\n\nSphinx is used to build the documentation based on rST files and comments in the code. First,\ninstall dependencies (feel free to reuse the virtual environment from above):\n\n.. code-block:: shell\n\n python3 -m venv .venv\n source .venv/bin/activate\n pip install Sphinx sphinx-rtd-theme\n\nNow, once you have the virtual environment activated:\n\n.. code-block:: shell\n\n cd docs\n sphinx-build -E -W -b html . _build/html\n\nThis will output the documentation to ``docs/_build/html``. Open the index.html in your browser to\nview them. It will also (due to -W) error out on any warning like Travis will. This is a good way to\nlocally verify it will pass.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "UI Buttons for displayio",
"version": "1.11.2",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_Display_Button"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" display_button",
" buttons",
" ui"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9b5dcce942768efb2ae7c6e2af3bafc4cccfbc9cb7d5bdc2956154d093e30a91",
"md5": "c5fe9a7db552f78a652a2bb1b8a0f17c",
"sha256": "518dd88fd34423101f79192e4e8626dd534f8cb7d6dffd07f31a8c2ca12d07a4"
},
"downloads": -1,
"filename": "adafruit_circuitpython_display_button-1.11.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c5fe9a7db552f78a652a2bb1b8a0f17c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 10781,
"upload_time": "2025-01-16T19:42:37",
"upload_time_iso_8601": "2025-01-16T19:42:37.732931Z",
"url": "https://files.pythonhosted.org/packages/9b/5d/cce942768efb2ae7c6e2af3bafc4cccfbc9cb7d5bdc2956154d093e30a91/adafruit_circuitpython_display_button-1.11.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "21691bdcbe8b7c282b1cab1ac3446399c9182003708d51a131ec09736b1543e7",
"md5": "54ebaabbf05d34572d777906a9eb3f7f",
"sha256": "cdfa0b1b695cbcee5301a32ae97cce4443eb1f8d7fa2da0664277c85724c0e01"
},
"downloads": -1,
"filename": "adafruit_circuitpython_display_button-1.11.2.tar.gz",
"has_sig": false,
"md5_digest": "54ebaabbf05d34572d777906a9eb3f7f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 38927,
"upload_time": "2025-01-16T19:42:40",
"upload_time_iso_8601": "2025-01-16T19:42:40.622103Z",
"url": "https://files.pythonhosted.org/packages/21/69/1bdcbe8b7c282b1cab1ac3446399c9182003708d51a131ec09736b1543e7/adafruit_circuitpython_display_button-1.11.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-16 19:42:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_Display_Button",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka-displayio",
"specs": []
},
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-circuitpython-bitmap-font",
"specs": []
},
{
"name": "adafruit-circuitpython-display-text",
"specs": []
},
{
"name": "adafruit-circuitpython-display-shapes",
"specs": []
}
],
"lcname": "adafruit-circuitpython-display-button"
}