{"id":15018614,"url":"https://github.com/adafruit/adafruit_circuitpython_led_animation","last_synced_at":"2025-04-12T17:41:40.067Z","repository":{"id":44140405,"uuid":"133384127","full_name":"adafruit/Adafruit_CircuitPython_LED_Animation","owner":"adafruit","description":"CircuitPython helper library for LED colors and animations","archived":false,"fork":false,"pushed_at":"2025-01-16T19:48:06.000Z","size":369,"stargazers_count":60,"open_issues_count":11,"forks_count":45,"subscribers_count":18,"default_branch":"main","last_synced_at":"2025-04-11T19:07:29.516Z","etag":null,"topics":["animation","circuitpython","hacktoberfest","led"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"apatt/led_animation","license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/adafruit.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-05-14T15:37:11.000Z","updated_at":"2025-03-29T02:37:11.000Z","dependencies_parsed_at":"2023-02-15T12:00:54.694Z","dependency_job_id":"77c0a240-e183-4ce8-b1ee-914bdb8d3d73","html_url":"https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation","commit_stats":{"total_commits":312,"total_committers":30,"mean_commits":10.4,"dds":0.6153846153846154,"last_synced_commit":"7fd9f41ba1e5eeab2f67f932f192c1b1919dd1cd"},"previous_names":[],"tags_count":67,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adafruit%2FAdafruit_CircuitPython_LED_Animation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adafruit%2FAdafruit_CircuitPython_LED_Animation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adafruit%2FAdafruit_CircuitPython_LED_Animation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adafruit%2FAdafruit_CircuitPython_LED_Animation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adafruit","download_url":"https://codeload.github.com/adafruit/Adafruit_CircuitPython_LED_Animation/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248607941,"owners_count":21132639,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["animation","circuitpython","hacktoberfest","led"],"created_at":"2024-09-24T19:52:11.378Z","updated_at":"2025-04-12T17:41:40.011Z","avatar_url":"https://github.com/adafruit.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"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 \u003chttps://github.com/adafruit/circuitpython\u003e`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle \u003chttps://github.com/adafruit/Adafruit_CircuitPython_Bundle\u003e`_.\n\n\nInstalling from PyPI\n=====================\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI \u003chttps://pypi.org/project/adafruit-circuitpython-led-animation/\u003e`_. 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 \u0026\u0026 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 \u003chttps://docs.circuitpython.org/projects/led-animation/en/latest/\u003e`_.\n\nFor information on building library documentation, please check out `this guide \u003chttps://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1\u003e`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n\u003chttps://github.com/apatt/CircuitPython_LED_Animation/blob/main/CODE_OF_CONDUCT.md\u003e`_\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 \u003chttps://github.com/adafruit/circuitpython-build-tools\u003e`_ 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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadafruit%2Fadafruit_circuitpython_led_animation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadafruit%2Fadafruit_circuitpython_led_animation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadafruit%2Fadafruit_circuitpython_led_animation/lists"}