Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-display-shapes/badge/?version=latest
:target: https://docs.circuitpython.org/projects/display-shapes/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_Shapes/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_Display_Shapes/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
Various common shapes for use with 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>`_.
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-display_shapes/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-display_shapes
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-display_shapes
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-display_shapes
Usage Example
=============
.. code-block:: python
import board
import displayio
from adafruit_display_shapes.rect import Rect
from adafruit_display_shapes.circle import Circle
from adafruit_display_shapes.arc import Arc
from adafruit_display_shapes.roundrect import RoundRect
splash = displayio.Group()
board.DISPLAY.root_group = splash
color_bitmap = displayio.Bitmap(320, 240, 1)
color_palette = displayio.Palette(1)
color_palette[0] = 0xFFFFFF
bg_sprite = displayio.TileGrid(color_bitmap, pixel_shader=color_palette, position=(0, 0))
print(bg_sprite.position)
splash.append(bg_sprite)
triangle = Triangle(170, 50, 120, 140, 210, 160, fill=0x00FF00, outline=0xFF00FF)
splash.append(triangle)
rect = Rect(80, 20, 41, 41, fill=0x0)
splash.append(rect)
circle = Circle(100, 100, 20, fill=0x00FF00, outline=0xFF00FF)
splash.append(circle)
arc = Arc(x=100, y=100, radius=25, angle=45, direction=90, segments=10, outline=0x00FF00)
splash.append(arc)
rect2 = Rect(50, 100, 61, 81, outline=0x0, stroke=3)
splash.append(rect2)
roundrect = RoundRect(10, 10, 61, 81, 10, fill=0x0, outline=0xFF00FF, stroke=6)
splash.append(roundrect)
while True:
pass
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/display-shapes/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_Shapes/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Building locally
================
Zip release files
-----------------
To build this library locally you'll need to install the
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
.. code-block:: shell
python3 -m venv .venv
source .venv/bin/activate
pip install circuitpython-build-tools
Once installed, make sure you are in the virtual environment:
.. code-block:: shell
source .venv/bin/activate
Then run the build:
.. code-block:: shell
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-display_shapes --library_location .
Sphinx documentation
-----------------------
Sphinx is used to build the documentation based on rST files and comments in the code. First,
install dependencies (feel free to reuse the virtual environment from above):
.. code-block:: shell
python3 -m venv .venv
source .venv/bin/activate
pip install Sphinx sphinx-rtd-theme
Now, once you have the virtual environment activated:
.. code-block:: shell
cd docs
sphinx-build -E -W -b html . _build/html
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
locally verify it will pass.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-display-shapes",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,display_shapes,shapes,displayio,drawing",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/e4/74/0a83fdcf836577ae643b0a1ae21ef37870f52e57d699c10783536ebac5b0/adafruit-circuitpython-display_shapes-2.8.2.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-display-shapes/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/display-shapes/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_Shapes/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_Display_Shapes/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\nVarious common shapes for use with displayio\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://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n--------------------\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-display_shapes/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-display_shapes\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-display_shapes\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-display_shapes\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import board\n import displayio\n from adafruit_display_shapes.rect import Rect\n from adafruit_display_shapes.circle import Circle\n from adafruit_display_shapes.arc import Arc\n from adafruit_display_shapes.roundrect import RoundRect\n\n splash = displayio.Group()\n board.DISPLAY.root_group = splash\n\n color_bitmap = displayio.Bitmap(320, 240, 1)\n color_palette = displayio.Palette(1)\n color_palette[0] = 0xFFFFFF\n bg_sprite = displayio.TileGrid(color_bitmap, pixel_shader=color_palette, position=(0, 0))\n print(bg_sprite.position)\n splash.append(bg_sprite)\n\n triangle = Triangle(170, 50, 120, 140, 210, 160, fill=0x00FF00, outline=0xFF00FF)\n splash.append(triangle)\n\n rect = Rect(80, 20, 41, 41, fill=0x0)\n splash.append(rect)\n\n circle = Circle(100, 100, 20, fill=0x00FF00, outline=0xFF00FF)\n splash.append(circle)\n\n arc = Arc(x=100, y=100, radius=25, angle=45, direction=90, segments=10, outline=0x00FF00)\n splash.append(arc)\n\n rect2 = Rect(50, 100, 61, 81, outline=0x0, stroke=3)\n splash.append(rect2)\n\n roundrect = RoundRect(10, 10, 61, 81, 10, fill=0x0, outline=0xFF00FF, stroke=6)\n splash.append(roundrect)\n\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-shapes/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_Shapes/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n\nBuilding locally\n================\n\nZip release files\n-----------------\n\nTo build this library locally you'll need to install the\n`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.\n\n.. code-block:: shell\n\n python3 -m venv .venv\n source .venv/bin/activate\n pip install circuitpython-build-tools\n\nOnce installed, make sure you are in the virtual environment:\n\n.. code-block:: shell\n\n source .venv/bin/activate\n\nThen run the build:\n\n.. code-block:: shell\n\n circuitpython-build-bundles --filename_prefix adafruit-circuitpython-display_shapes --library_location .\n\nSphinx documentation\n-----------------------\n\nSphinx is used to build the documentation based on rST files and comments in the code. First,\ninstall dependencies (feel free to reuse the virtual environment from above):\n\n.. code-block:: shell\n\n python3 -m venv .venv\n source .venv/bin/activate\n pip install Sphinx sphinx-rtd-theme\n\nNow, once you have the virtual environment activated:\n\n.. code-block:: shell\n\n cd docs\n sphinx-build -E -W -b html . _build/html\n\nThis will output the documentation to ``docs/_build/html``. Open the index.html in your browser to\nview them. It will also (due to -W) error out on any warning like Travis will. This is a good way to\nlocally verify it will pass.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Various common shapes for use with displayio",
"version": "2.8.2",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_Display_Shapes"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"display_shapes",
"shapes",
"displayio",
"drawing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9810310f7cd92f2f30584922fac7d1fa31c66929056e664ab0f954506c865182",
"md5": "9e847dc39228793391d1ee7b5dd928ee",
"sha256": "86345ebd0c1b61f11aef4238169f4a4d81979dde515d5b78f5179a3a32711e40"
},
"downloads": -1,
"filename": "adafruit_circuitpython_display_shapes-2.8.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9e847dc39228793391d1ee7b5dd928ee",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 19310,
"upload_time": "2024-01-23T00:08:38",
"upload_time_iso_8601": "2024-01-23T00:08:38.626896Z",
"url": "https://files.pythonhosted.org/packages/98/10/310f7cd92f2f30584922fac7d1fa31c66929056e664ab0f954506c865182/adafruit_circuitpython_display_shapes-2.8.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e4740a83fdcf836577ae643b0a1ae21ef37870f52e57d699c10783536ebac5b0",
"md5": "fd91ff49deacf81a8079cab4e4406f46",
"sha256": "5987e513d0c04eeb7fbf8af0a68529153004f96bc9493fd26a807f426287adab"
},
"downloads": -1,
"filename": "adafruit-circuitpython-display_shapes-2.8.2.tar.gz",
"has_sig": false,
"md5_digest": "fd91ff49deacf81a8079cab4e4406f46",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 38747,
"upload_time": "2024-01-23T00:08:40",
"upload_time_iso_8601": "2024-01-23T00:08:40.249696Z",
"url": "https://files.pythonhosted.org/packages/e4/74/0a83fdcf836577ae643b0a1ae21ef37870f52e57d699c10783536ebac5b0/adafruit-circuitpython-display_shapes-2.8.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-23 00:08:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_Display_Shapes",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-display-shapes"
}
JSON
