adafruit-circuitpython-display-text


Nameadafruit-circuitpython-display-text JSON
Version 3.1.5 PyPI version JSON
download
home_pageNone
SummaryDisplays text using CircuitPython's displayio.
upload_time2024-11-02 21:24:01
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseMIT
keywords adafruit blinka circuitpython micropython bitmap fonts text display tft lcd displayio
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Introduction
============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-display_text/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/display_text/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_Text/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_Display_Text/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

Displays text using CircuitPython's 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>`_.

Usage Example
=============

For a board with a built-in display.

.. code:: python

    import board
    import terminalio
    from adafruit_display_text import label


    text = "Hello world"
    text_area = label.Label(terminalio.FONT, text=text)
    text_area.x = 10
    text_area.y = 10
    board.DISPLAY.root_group = text_area
    while True:
        pass


Documentation
=============

API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/display_text/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_Text/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "adafruit-circuitpython-display-text",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "adafruit, blinka, circuitpython, micropython, bitmap, fonts, text, display, tft, lcd, displayio",
    "author": null,
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/af/23/9112d59738d7823507693cfbfd56ecb29a24c21f779cdb231152555c684b/adafruit_circuitpython_display_text-3.1.5.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-display_text/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/display_text/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_Text/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_Display_Text/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\nDisplays text using CircuitPython's displayio.\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\nUsage Example\n=============\n\nFor a board with a built-in display.\n\n.. code:: python\n\n    import board\n    import terminalio\n    from adafruit_display_text import label\n\n\n    text = \"Hello world\"\n    text_area = label.Label(terminalio.FONT, text=text)\n    text_area.x = 10\n    text_area.y = 10\n    board.DISPLAY.root_group = text_area\n    while True:\n        pass\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/display_text/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_Text/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Displays text using CircuitPython's displayio.",
    "version": "3.1.5",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_Display_Text"
    },
    "split_keywords": [
        "adafruit",
        " blinka",
        " circuitpython",
        " micropython",
        " bitmap",
        " fonts",
        " text",
        " display",
        " tft",
        " lcd",
        " displayio"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "32e02ce6b6eb73021219a449716be200f95c87d0baee7a8345fb4f7e0523c10d",
                "md5": "da53859d72682efe5e2a2c010463557e",
                "sha256": "54367936798c75df09c855a56aebb0c53a302d60e523fcca754b9b71d21c4476"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_display_text-3.1.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "da53859d72682efe5e2a2c010463557e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 22177,
            "upload_time": "2024-11-02T21:23:59",
            "upload_time_iso_8601": "2024-11-02T21:23:59.975066Z",
            "url": "https://files.pythonhosted.org/packages/32/e0/2ce6b6eb73021219a449716be200f95c87d0baee7a8345fb4f7e0523c10d/adafruit_circuitpython_display_text-3.1.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "af239112d59738d7823507693cfbfd56ecb29a24c21f779cdb231152555c684b",
                "md5": "bb1749791ffd9cc7992c8edd3bec5635",
                "sha256": "f0d1ac16454c5c9a50769fad80aa494a5b25b1e08c450e9cfdee81e908738cc2"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_display_text-3.1.5.tar.gz",
            "has_sig": false,
            "md5_digest": "bb1749791ffd9cc7992c8edd3bec5635",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 81842,
            "upload_time": "2024-11-02T21:24:01",
            "upload_time_iso_8601": "2024-11-02T21:24:01.844004Z",
            "url": "https://files.pythonhosted.org/packages/af/23/9112d59738d7823507693cfbfd56ecb29a24c21f779cdb231152555c684b/adafruit_circuitpython_display_text-3.1.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-02 21:24:01",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_Display_Text",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "adafruit-circuitpython-display-text"
}
        
Elapsed time: 0.59693s