adafruit-circuitpython-simple-text-display


Nameadafruit-circuitpython-simple-text-display JSON
Version 1.2.15 PyPI version JSON
download
home_page
SummaryA helper library for displaying lines of text on a microcontroller with a built-in display, or externally connected display.
upload_time2023-12-09 17:53:56
maintainer
docs_urlNone
author
requires_python
licenseMIT
keywords adafruit blinka circuitpython micropython simple-text-display displayio
VCS
bugtrack_url
requirements Adafruit-Blinka adafruit-circuitpython-display-text
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Introduction
============


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

A helper library for displaying lines of text on a display using displayio.


Dependencies
=============
This driver depends on:

* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Adafruit CircuitPython DisplayText <https://github.com/adafruit/Adafruit_CircuitPython_Display_Text>`_

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>`_.

This library works with any microcontroller with a built in display, or a microcontroller with an
external display connected.

`Purchase one from the Adafruit shop. <http://www.adafruit.com>`_


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

This example takes the microcontroller CPU temperature in C and F, and displays it on the display
under the heading "Temperature Data!".

.. code-block:: python

    import microcontroller
    from adafruit_simple_text_display import SimpleTextDisplay

    temperature_data = SimpleTextDisplay(title="Temperature Data!", title_scale=2)

    while True:
        temperature_data[0].text = "Temperature: {:.2f} degrees C".format(
            microcontroller.cpu.temperature
        )
        temperature_data[1].text = "Temperature: {:.2f} degrees F".format(
            (microcontroller.cpu.temperature * (9 / 5) + 32)
        )
        temperature_data.show()

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

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

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "adafruit-circuitpython-simple-text-display",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "adafruit,blinka,circuitpython,micropython,simple-text-display,displayio",
    "author": "",
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/0b/21/655e0dda4a0e738de78c19a69f73da7972f1e9518ee6a6f8df7132901a15/adafruit-circuitpython-simple-text-display-1.2.15.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-simple-text-display/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/simple-text-display/en/latest/\n    :alt: Documentation Status\n\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\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Simple_Text_Display/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_Simple_Text_Display/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\nA helper library for displaying lines of text on a display using displayio.\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Adafruit CircuitPython DisplayText <https://github.com/adafruit/Adafruit_CircuitPython_Display_Text>`_\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\nThis library works with any microcontroller with a built in display, or a microcontroller with an\nexternal display connected.\n\n`Purchase one from the Adafruit shop. <http://www.adafruit.com>`_\n\n\nUsage Example\n=============\n\nThis example takes the microcontroller CPU temperature in C and F, and displays it on the display\nunder the heading \"Temperature Data!\".\n\n.. code-block:: python\n\n    import microcontroller\n    from adafruit_simple_text_display import SimpleTextDisplay\n\n    temperature_data = SimpleTextDisplay(title=\"Temperature Data!\", title_scale=2)\n\n    while True:\n        temperature_data[0].text = \"Temperature: {:.2f} degrees C\".format(\n            microcontroller.cpu.temperature\n        )\n        temperature_data[1].text = \"Temperature: {:.2f} degrees F\".format(\n            (microcontroller.cpu.temperature * (9 / 5) + 32)\n        )\n        temperature_data.show()\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/simple-text-display/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_Simple_Text_Display/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A helper library for displaying lines of text on a microcontroller with a built-in display, or externally connected display.",
    "version": "1.2.15",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_Simple_Text_Display.git"
    },
    "split_keywords": [
        "adafruit",
        "blinka",
        "circuitpython",
        "micropython",
        "simple-text-display",
        "displayio"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5e402e721e39d171d45145dc0221733e4904f289eba5947e51bc28d9862cd878",
                "md5": "b12e661a12dc7e476b78895f96a53827",
                "sha256": "9532f6ad8bda1a4a4f269b63b31335c0f71fd735c7a14a95ba4f7a70ee9c7d27"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_simple_text_display-1.2.15-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b12e661a12dc7e476b78895f96a53827",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 6540,
            "upload_time": "2023-12-09T17:53:52",
            "upload_time_iso_8601": "2023-12-09T17:53:52.921222Z",
            "url": "https://files.pythonhosted.org/packages/5e/40/2e721e39d171d45145dc0221733e4904f289eba5947e51bc28d9862cd878/adafruit_circuitpython_simple_text_display-1.2.15-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0b21655e0dda4a0e738de78c19a69f73da7972f1e9518ee6a6f8df7132901a15",
                "md5": "0658c3e574879c1fe147bc5f128c5442",
                "sha256": "7db060eabeb22f2c37ee1e06637db355e933bcc4a20b7df45b5cb8767d9c8ed5"
            },
            "downloads": -1,
            "filename": "adafruit-circuitpython-simple-text-display-1.2.15.tar.gz",
            "has_sig": false,
            "md5_digest": "0658c3e574879c1fe147bc5f128c5442",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 27347,
            "upload_time": "2023-12-09T17:53:56",
            "upload_time_iso_8601": "2023-12-09T17:53:56.247440Z",
            "url": "https://files.pythonhosted.org/packages/0b/21/655e0dda4a0e738de78c19a69f73da7972f1e9518ee6a6f8df7132901a15/adafruit-circuitpython-simple-text-display-1.2.15.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-09 17:53:56",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_Simple_Text_Display",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "Adafruit-Blinka",
            "specs": []
        },
        {
            "name": "adafruit-circuitpython-display-text",
            "specs": []
        }
    ],
    "lcname": "adafruit-circuitpython-simple-text-display"
}
        
Elapsed time: 0.17087s