adafruit-circuitpython-displayio-layout


Nameadafruit-circuitpython-displayio-layout JSON
Version 2.1.0 PyPI version JSON
download
home_page
SummaryCircuitPython helper library for displayio layouts and widgets.
upload_time2024-02-05 19:45:42
maintainer
docs_urlNone
author
requires_python
licenseMIT
keywords adafruit blinka circuitpython micropython displayio_layout displayio gui layout widget
VCS
bugtrack_url
requirements Adafruit-Blinka-displayio Adafruit-Blinka adafruit-circuitpython-bitmap-font adafruit-circuitpython-display-text adafruit-circuitpython-imageload adafruit-circuitpython-display-shapes
Travis-CI No Travis.
coveralls test coverage No coveralls.
            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/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
    :alt: Code Style: Black

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": "",
    "name": "adafruit-circuitpython-displayio-layout",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "adafruit,blinka,circuitpython,micropython,displayio_layout,displayio,gui,layout,widget",
    "author": "",
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/49/a5/9d71c1f69fa59f06afef32e4e264c15dcf72c7d078025914f69e033680f1/adafruit-circuitpython-displayio-layout-2.1.0.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/badge/code%20style-black-000000.svg\n    :target: https://github.com/psf/black\n    :alt: Code Style: Black\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": "2.1.0",
    "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": "",
            "digests": {
                "blake2b_256": "47cfc49cca0a78eddac19b9da38a7f2f2a468768fbf2c012b26259fb251bc04b",
                "md5": "78a900b8fede165a4151ac5d5e3bbe53",
                "sha256": "fc4c21f1806c61e2dc1b55a0cf2b42908682c100a62bd1c6ec24713113bfd217"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_displayio_layout-2.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "78a900b8fede165a4151ac5d5e3bbe53",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 49279,
            "upload_time": "2024-02-05T19:45:40",
            "upload_time_iso_8601": "2024-02-05T19:45:40.349110Z",
            "url": "https://files.pythonhosted.org/packages/47/cf/c49cca0a78eddac19b9da38a7f2f2a468768fbf2c012b26259fb251bc04b/adafruit_circuitpython_displayio_layout-2.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "49a59d71c1f69fa59f06afef32e4e264c15dcf72c7d078025914f69e033680f1",
                "md5": "42cfdfa913b0798fd68adaad86a3cd20",
                "sha256": "d7826dda31fdcceaec8fcce04617bf17e6d1ef8a67e43dd625d5818a2b4cfc4f"
            },
            "downloads": -1,
            "filename": "adafruit-circuitpython-displayio-layout-2.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "42cfdfa913b0798fd68adaad86a3cd20",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 234165,
            "upload_time": "2024-02-05T19:45:42",
            "upload_time_iso_8601": "2024-02-05T19:45:42.642787Z",
            "url": "https://files.pythonhosted.org/packages/49/a5/9d71c1f69fa59f06afef32e4e264c15dcf72c7d078025914f69e033680f1/adafruit-circuitpython-displayio-layout-2.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-05 19:45:42",
    "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": []
        }
    ],
    "lcname": "adafruit-circuitpython-displayio-layout"
}
        
Elapsed time: 0.18024s