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/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
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/29/12/893e328f591455c52cd53230c02af46b7a61c81618bfbbf7b7747dd6b939/adafruit_circuitpython_fancyled-1.4.20.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/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\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.20",
"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": "f5e89b243123af55eea54313a49e9a318deb9c8d4c23e0df4ed7835087ea2a4b",
"md5": "9aab28d04b03525569d81fd0c382890b",
"sha256": "8acf0b18203d5d5974fc860aee5f178cdde7592531a31b95a8745b6ae2c0bf75"
},
"downloads": -1,
"filename": "adafruit_circuitpython_fancyled-1.4.20-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9aab28d04b03525569d81fd0c382890b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 13279,
"upload_time": "2024-10-07T22:30:34",
"upload_time_iso_8601": "2024-10-07T22:30:34.001081Z",
"url": "https://files.pythonhosted.org/packages/f5/e8/9b243123af55eea54313a49e9a318deb9c8d4c23e0df4ed7835087ea2a4b/adafruit_circuitpython_fancyled-1.4.20-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2912893e328f591455c52cd53230c02af46b7a61c81618bfbbf7b7747dd6b939",
"md5": "17d6a365b766ae0cb21435a38682362e",
"sha256": "fb88ce0a4cb78341093b27cad7e02358d167540e1975c26f9c10c08325336438"
},
"downloads": -1,
"filename": "adafruit_circuitpython_fancyled-1.4.20.tar.gz",
"has_sig": false,
"md5_digest": "17d6a365b766ae0cb21435a38682362e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 33997,
"upload_time": "2024-10-07T22:30:34",
"upload_time_iso_8601": "2024-10-07T22:30:34.822250Z",
"url": "https://files.pythonhosted.org/packages/29/12/893e328f591455c52cd53230c02af46b7a61c81618bfbbf7b7747dd6b939/adafruit_circuitpython_fancyled-1.4.20.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 22:30:34",
"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
