Skip to content
various shapes!
Python
Branch: master
Clone or download
Pull request Compare This branch is 15 commits ahead of ladyada:master.
makermelissa Merge pull request #8 from DavePutz/master
Changes to shape objects to explicitly set opaque property when changing colors
Latest commit 6219aa0 Nov 1, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
adafruit_display_shapes fixing a naming issue Oct 31, 2019
docs Updated doc files for new Triangle shape Aug 6, 2019
examples
.gitignore
.pylintrc cookied Mar 4, 2019
.readthedocs.yml cookied Mar 4, 2019
.travis.yml
CODE_OF_CONDUCT.md cookied Mar 4, 2019
LICENSE cookied Mar 4, 2019
README.rst Updated doc files for new Triangle shape Aug 6, 2019
requirements.txt cookied Mar 4, 2019
setup.py Update for release. Mar 21, 2019

README.rst

Introduction

Documentation Status Discord Build Status

Various common shapes for use with displayio

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-display_shapes

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-display_shapes

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .env
source .env/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.roundrect import RoundRect

splash = displayio.Group(max_size=10) board.DISPLAY.show(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)

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

Contributing

Contributions are welcome! Please read our Code of Conduct 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 package.

python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools

Once installed, make sure you are in the virtual environment:

source .env/bin/activate

Then run the build:

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):

python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

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.

You can’t perform that action at this time.