Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-displayio-layout/badge/?version=latest
:target: https://docs.circuitpython.org/projects/displayio-layout/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_DisplayIO_Layout/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_Layout/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
CircuitPython helper library for displayio layouts and widgets.
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>`_.
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-displayio_layout/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-displayio-layout
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-displayio-layout
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-displayio-layout
Usage Example
=============
See scripts in the examples directory of this repository.
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/displayio-layout/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_DisplayIO_Layout/blob/master/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-displayio-layout",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, displayio_layout, displayio, gui, layout, widget",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/cb/1e/e0a742975882f6410d0ab3c63bd79b391c2db96618560e795b70ffc00445/adafruit_circuitpython_displayio_layout-3.1.1.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-displayio-layout/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/displayio-layout/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_DisplayIO_Layout/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_Layout/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\nCircuitPython helper library for displayio layouts and widgets.\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>`_.\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-displayio_layout/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-displayio-layout\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-displayio-layout\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-displayio-layout\n\nUsage Example\n=============\n\nSee scripts in the examples directory of this repository.\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/displayio-layout/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_DisplayIO_Layout/blob/master/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython helper library for displayio layouts and widgets.",
"version": "3.1.1",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_Layout"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" displayio_layout",
" displayio",
" gui",
" layout",
" widget"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "100e46a5d6782670c36eb286c9ce89db1cbfff77a2b3d7efd951578f73317a0b",
"md5": "69e85cfba074c0cb0f1313b8cdd59e6f",
"sha256": "5543d6081f6fc04adf1ec7b1332478cf08c343d077ccb983ae210577739d02aa"
},
"downloads": -1,
"filename": "adafruit_circuitpython_displayio_layout-3.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "69e85cfba074c0cb0f1313b8cdd59e6f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 51020,
"upload_time": "2025-09-08T19:56:17",
"upload_time_iso_8601": "2025-09-08T19:56:17.524609Z",
"url": "https://files.pythonhosted.org/packages/10/0e/46a5d6782670c36eb286c9ce89db1cbfff77a2b3d7efd951578f73317a0b/adafruit_circuitpython_displayio_layout-3.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "cb1ee0a742975882f6410d0ab3c63bd79b391c2db96618560e795b70ffc00445",
"md5": "27666d67bea253deaa44682ad210e8d3",
"sha256": "882a075fa05cee2b3a8204d709b4a51c9fb1eb90586545d2bbd09b0df9898248"
},
"downloads": -1,
"filename": "adafruit_circuitpython_displayio_layout-3.1.1.tar.gz",
"has_sig": false,
"md5_digest": "27666d67bea253deaa44682ad210e8d3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 232309,
"upload_time": "2025-09-08T19:56:18",
"upload_time_iso_8601": "2025-09-08T19:56:18.593063Z",
"url": "https://files.pythonhosted.org/packages/cb/1e/e0a742975882f6410d0ab3c63bd79b391c2db96618560e795b70ffc00445/adafruit_circuitpython_displayio_layout-3.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-08 19:56:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_DisplayIO_Layout",
"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-imageload",
"specs": []
},
{
"name": "adafruit-circuitpython-display-shapes",
"specs": []
},
{
"name": "adafruit-circuitpython-typing",
"specs": []
}
],
"lcname": "adafruit-circuitpython-displayio-layout"
}