Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-fancyled/badge/?version=latest
:target: https://docs.circuitpython.org/projects/fancyled/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_FancyLED/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_FancyLED/actions/
:alt: Build Status
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
:target: https://github.com/astral-sh/ruff
:alt: Code Style: Ruff
FancyLED is a CircuitPython library to assist in creating buttery smooth LED animation. It's loosely inspired by the FastLED library for Arduino, and in fact we have a "helper" library using similar function names to assist with porting of existing Arduino FastLED projects to CircuitPython.
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-fancyled/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-fancyled
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-fancyled
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-fancyled
Usage Example
=============
See the examples in the examples/ folder.
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/fancyled/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/PaintYourDragon/Adafruit_CircuitPython_fancyled/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-fancyled",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, fancyled, fastled, led, animation, rgb, hardware, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/74/b7/11db271480a462425235733ffc8fc35da0b6fd57838fd1e0eee16bc6227f/adafruit_circuitpython_fancyled-1.4.21.tar.gz",
"platform": null,
"description": "\nIntroduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-fancyled/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/fancyled/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_FancyLED/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_FancyLED/actions/\n :alt: Build Status\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n :target: https://github.com/astral-sh/ruff\n :alt: Code Style: Ruff\n\nFancyLED is a CircuitPython library to assist in creating buttery smooth LED animation. It's loosely inspired by the FastLED library for Arduino, and in fact we have a \"helper\" library using similar function names to assist with porting of existing Arduino FastLED projects to CircuitPython.\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====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-fancyled/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-fancyled\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-fancyled\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-fancyled\n\nUsage Example\n=============\n\nSee the examples in the examples/ folder.\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/fancyled/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/PaintYourDragon/Adafruit_CircuitPython_fancyled/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython FancyLED helper library for LED animations.",
"version": "1.4.21",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_FancyLED"
},
"split_keywords": [
"adafruit",
" fancyled",
" fastled",
" led",
" animation",
" rgb",
" hardware",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "94c8b9c4f9331bf5d509418205aea3eb45ca28ca95d66fcccc6bbec756989dfb",
"md5": "e2304c5c02461bc39a5717d92baa70c4",
"sha256": "f3a37497ea488e86710fdcce98be6a4a6112210a895b42e3c777b917e77b74b8"
},
"downloads": -1,
"filename": "adafruit_circuitpython_fancyled-1.4.21-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e2304c5c02461bc39a5717d92baa70c4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 13206,
"upload_time": "2024-12-09T22:09:30",
"upload_time_iso_8601": "2024-12-09T22:09:30.285739Z",
"url": "https://files.pythonhosted.org/packages/94/c8/b9c4f9331bf5d509418205aea3eb45ca28ca95d66fcccc6bbec756989dfb/adafruit_circuitpython_fancyled-1.4.21-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "74b711db271480a462425235733ffc8fc35da0b6fd57838fd1e0eee16bc6227f",
"md5": "e1418c6cfb64fd31b1a08a531a01eb8e",
"sha256": "9ee1bf393a8e98aa04d0f6c352ed9791f79a085cf1bf8c157868adcc85d02a85"
},
"downloads": -1,
"filename": "adafruit_circuitpython_fancyled-1.4.21.tar.gz",
"has_sig": false,
"md5_digest": "e1418c6cfb64fd31b1a08a531a01eb8e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30714,
"upload_time": "2024-12-09T22:09:31",
"upload_time_iso_8601": "2024-12-09T22:09:31.730013Z",
"url": "https://files.pythonhosted.org/packages/74/b7/11db271480a462425235733ffc8fc35da0b6fd57838fd1e0eee16bc6227f/adafruit_circuitpython_fancyled-1.4.21.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-09 22:09:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_FancyLED",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-fancyled"
}
JSON
