Introduction
============
.. image:: https://readthedocs.org/projects/adafruit_circuitpython_led_animation/badge/?version=latest
:target: https://docs.circuitpython.org/projects/led-animation/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_LED_Animation/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation/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
Perform a variety of LED animation tasks
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-led-animation/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-led-animation
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-led-animation
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-led-animation
Usage Example
=============
.. code-block:: python
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 <https://docs.circuitpython.org/projects/led-animation/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/apatt/CircuitPython_LED_Animation/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 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):
.. 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-led-animation",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,led,animation,led,colors,animations",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/df/d5/dd24d863a92c806603ec521afe8dee844c766dc81178e5b74137cc4d3f4d/adafruit-circuitpython-led-animation-2.9.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit_circuitpython_led_animation/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/led-animation/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_LED_Animation/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation/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\nPerform a variety of LED animation tasks\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\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-led-animation/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-led-animation\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-led-animation\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-led-animation\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import board\n import neopixel\n from adafruit_led_animation.animation.blink import Blink\n import adafruit_led_animation.color as color\n\n # Works on Circuit Playground Express and Bluefruit.\n # For other boards, change board.NEOPIXEL to match the pin to which the NeoPixels are attached.\n pixel_pin = board.NEOPIXEL\n # Change to match the number of pixels you have attached to your board.\n num_pixels = 10\n\n pixels = neopixel.NeoPixel(pixel_pin, num_pixels)\n blink = Blink(pixels, 0.5, color.PURPLE)\n\n while True:\n blink.animate()\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/led-animation/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/apatt/CircuitPython_LED_Animation/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 circuitpython-led_animation --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": "CircuitPython helper for LED colors and animations.",
"version": "2.9.0",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"led",
"animation",
"led",
"colors",
"animations"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7f2cb511bb698adb3d68ab6f523adcd94f28fbbf6460b79369220ce20e11c54c",
"md5": "bac726ba8d8c8935c791e67ec76166a6",
"sha256": "23f532622ca7a2fc0d4763c5dc38e6f72a34a24979700508db05b0799bb1224c"
},
"downloads": -1,
"filename": "adafruit_circuitpython_led_animation-2.9.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bac726ba8d8c8935c791e67ec76166a6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 40140,
"upload_time": "2024-02-05T19:47:14",
"upload_time_iso_8601": "2024-02-05T19:47:14.240132Z",
"url": "https://files.pythonhosted.org/packages/7f/2c/b511bb698adb3d68ab6f523adcd94f28fbbf6460b79369220ce20e11c54c/adafruit_circuitpython_led_animation-2.9.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dfd5dd24d863a92c806603ec521afe8dee844c766dc81178e5b74137cc4d3f4d",
"md5": "cfe8d59540631eebc97d56ae2f45c567",
"sha256": "95c5eee857b8417bd1439337348fe141489f02ff786d63c0a3381a8e6dbe082f"
},
"downloads": -1,
"filename": "adafruit-circuitpython-led-animation-2.9.0.tar.gz",
"has_sig": false,
"md5_digest": "cfe8d59540631eebc97d56ae2f45c567",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 48127,
"upload_time": "2024-02-05T19:47:16",
"upload_time_iso_8601": "2024-02-05T19:47:16.127569Z",
"url": "https://files.pythonhosted.org/packages/df/d5/dd24d863a92c806603ec521afe8dee844c766dc81178e5b74137cc4d3f4d/adafruit-circuitpython-led-animation-2.9.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-05 19:47:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_LED_Animation",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
}
],
"lcname": "adafruit-circuitpython-led-animation"
}
JSON
