adafruit-circuitpython-led-animation

Introduction

Perform a variety of LED animation tasks

Dependencies

This driver depends on:

Adafruit CircuitPython

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-led-animation

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

sudo pip3 install adafruit-circuitpython-led-animation

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-led-animation

Usage Example

import board
import neopixel
from adafruit_led_animation.animation.blink import Blink
import adafruit_led_animation.color as color

# Works on Circuit Playground Express and Bluefruit.
# For other boards, change board.NEOPIXEL to match the pin to which the NeoPixels are attached.
pixel_pin = board.NEOPIXEL
# Change to match the number of pixels you have attached to your board.
num_pixels = 10

pixels = neopixel.NeoPixel(pixel_pin, num_pixels)
blink = Blink(pixels, 0.5, color.PURPLE)

while True:
    blink.animate()

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

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 .venv
source .venv/bin/activate
pip install circuitpython-build-tools

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

source .venv/bin/activate

Then run the build:

circuitpython-build-bundles --filename_prefix circuitpython-led_animation --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 .venv
source .venv/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.

Metadata

Release files for adafruit-circuitpython-led-animation 2.12.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for adafruit-circuitpython-led-animation 2.12.6
File	Size	Uploaded
adafruit_circuitpython_led_animation-2.12.6.tar.gz	46.0 kB	Apr 23, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for adafruit-circuitpython-led-animation 2.12.6
File	Interpreter	ABI	Platform	Reset
adafruit_circuitpython_led_animation-2.12.6-py3-none-any.whl 41.7 kB Apr 23, 2026	Python 3	none	any	Details

Total release size: 87.7 kB

Release files / adafruit_circuitpython_led_animation-2.12.6.tar.gz

Download URL	adafruit_circuitpython_led_animation-2.12.6.tar.gz
Size	46.0 kB
Tags	Source
SHA-256 checksum How to use checksums	`ad8c42c274836f3d1fe37230bf1e7651ce7224a99d2804e6b28c1c0d962f8ffb`
BLAKE2b-256 checksum How to use checksums	`f0cd9a5c60334d844a5c20f758e72439c79b85a43817457315680bacc1e0c6b7`
Upload date	Apr 23, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.11.15`

Release files / adafruit_circuitpython_led_animation-2.12.6-py3-none-any.whl

Download URL	adafruit_circuitpython_led_animation-2.12.6-py3-none-any.whl
Size	41.7 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`4efacbfe6ea98749819551d2a68f173fde2cd3b675c58c1096b5062ddbf03ec2`
BLAKE2b-256 checksum How to use checksums	`bca8b4253f41e95c92478fa9b4042b03ed8ed29934aca5ca393eb9096fd48dd9`
Upload date	Apr 23, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.11.15`