Introduction
============
.. image:: https://readthedocs.org/projects/circuitpython-displayio_annotation/badge/?version=latest
:target: https://circuitpython-displayio_annotation.readthedocs.io/
:alt: Documentation Status
.. image:: https://img.shields.io/discord/327254708534116352.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/circuitpython/CircuitPython_Org_DisplayIO_Annotation/workflows/Build%20CI/badge.svg
:target: https://github.com/circuitpython/CircuitPython_Org_DisplayIO_Annotation/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 CircuitPython DisplayIO widget for annotating other widgets or freeform positions.
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>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.
Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/circuitpython-displayio_annotation/>`_.
To install for current user:
.. code-block:: shell
pip3 install circuitpython-displayio-annotation
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install circuitpython-displayio-annotation
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install circuitpython-displayio-annotation
Usage Example
=============
See scripts in the examples directory of this repository.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/circuitpython/CircuitPython_Org_DisplayIO_Annotation/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Documentation
=============
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>`_.
Raw data
{
"_id": null,
"home_page": "https://github.com/circuitpython/CircuitPython_Org_DisplayIO_Annotation.git",
"name": "circuitpython-displayio-annotation",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,displayio,displayio_annotation,graphics,widget",
"author": "CircuitPython Organization",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/70/96/33ad34fac68d8e74ce66167aa923c35f368b09f612b37dbeb59d400ff970/circuitpython-displayio-annotation-2.0.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/circuitpython-displayio_annotation/badge/?version=latest\n :target: https://circuitpython-displayio_annotation.readthedocs.io/\n :alt: Documentation Status\n\n\n.. image:: https://img.shields.io/discord/327254708534116352.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n\n.. image:: https://github.com/circuitpython/CircuitPython_Org_DisplayIO_Annotation/workflows/Build%20CI/badge.svg\n :target: https://github.com/circuitpython/CircuitPython_Org_DisplayIO_Annotation/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 CircuitPython DisplayIO widget for annotating other widgets or freeform positions.\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>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\nInstalling from PyPI\n=====================\n\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/circuitpython-displayio_annotation/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install circuitpython-displayio-annotation\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install circuitpython-displayio-annotation\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 .env\n source .env/bin/activate\n pip3 install circuitpython-displayio-annotation\n\n\n\nUsage Example\n=============\n\nSee scripts in the examples directory of this repository.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/circuitpython/CircuitPython_Org_DisplayIO_Annotation/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n\nDocumentation\n=============\n\nFor information on building library documentation, please check out\n`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A CircuitPython DisplayIO widget for annotating other widgets or freeform positions.",
"version": "2.0.0",
"project_urls": {
"Homepage": "https://github.com/circuitpython/CircuitPython_Org_DisplayIO_Annotation"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"displayio",
"displayio_annotation",
"graphics",
"widget"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cf5fbc1be7e48c643ddf9ab7a40bc116b6857d114c9df834a2f85101da89ba33",
"md5": "23cbdca7b63c62749609316c81e2de67",
"sha256": "708bbaa5398caa76902aa4371bcedcd95e38efdcd7e509b305d0d94eea9bd3ee"
},
"downloads": -1,
"filename": "circuitpython_displayio_annotation-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "23cbdca7b63c62749609316c81e2de67",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5746,
"upload_time": "2023-10-31T22:23:50",
"upload_time_iso_8601": "2023-10-31T22:23:50.501211Z",
"url": "https://files.pythonhosted.org/packages/cf/5f/bc1be7e48c643ddf9ab7a40bc116b6857d114c9df834a2f85101da89ba33/circuitpython_displayio_annotation-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "709633ad34fac68d8e74ce66167aa923c35f368b09f612b37dbeb59d400ff970",
"md5": "2945eb56aa198800fea4d6cdff1fc85f",
"sha256": "e0e82dff81a0fca237f097d2918597196e2b476479553b2d056dc7f253868341"
},
"downloads": -1,
"filename": "circuitpython-displayio-annotation-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "2945eb56aa198800fea4d6cdff1fc85f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 32761,
"upload_time": "2023-10-31T22:23:51",
"upload_time_iso_8601": "2023-10-31T22:23:51.990546Z",
"url": "https://files.pythonhosted.org/packages/70/96/33ad34fac68d8e74ce66167aa923c35f368b09f612b37dbeb59d400ff970/circuitpython-displayio-annotation-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-31 22:23:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "circuitpython",
"github_project": "CircuitPython_Org_DisplayIO_Annotation",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "circuitpython-displayio-annotation"
}
JSON
