Introduction
============
.. image:: https://readthedocs.org/projects/foamyguy-circuitpython-gradienthelper/badge/?version=latest
:target: https://circuitpython-gradienthelper.readthedocs.io/
:alt: Documentation Status
.. image:: https://img.shields.io/discord/327254708534116352.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/Foamyguy/Foamyguy_CircuitPython_GradientHelper/workflows/Build%20CI/badge.svg
:target: https://github.com/Foamyguy/Foamyguy_CircuitPython_GradientHelper/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
Tools for generating color gradient palettes and sha
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://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/Foamyguy-circuitpython-gradienthelper/>`_.
To install for current user:
.. code-block:: shell
pip3 install Foamyguy-circuitpython-gradienthelper
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install Foamyguy-circuitpython-gradienthelper
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install Foamyguy-circuitpython-gradienthelper
Installing to a Connected CircuitPython Device with Circup
==========================================================
Make sure that you have ``circup`` installed in your Python environment.
Install it with the following command if necessary:
.. code-block:: shell
pip3 install circup
With ``circup`` installed and your CircuitPython device connected use the
following command to install:
.. code-block:: shell
circup install gradienthelper
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
.. code-block:: python
from foamyguy_gradienthelper import (
linear_gradient,
polylinear_gradient,
bezier_gradient,
)
def print_palette(palette):
out_str = "["
for color in palette:
out_str = f"{out_str}{color:#0{8}x}, "
out_str = out_str[:-2]
out_str = f"{out_str}]"
print(out_str)
linear_colors = linear_gradient(0xFF0000, 0x0000FF, 10)
print_palette(linear_colors)
polylinear_colors = polylinear_gradient((0x00FF00, 0xFFFF00, 0x00FFFF), 30)
print_palette(polylinear_colors)
bezier_colors = bezier_gradient((0xFF00FF, 0x00FFFF, 0x00FF00), 100)
print_palette(bezier_colors)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://circuitpython-gradienthelper.readthedocs.io/>`_.
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/Foamyguy/Foamyguy_CircuitPython_GradientHelper/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "foamyguy-circuitpython-gradienthelper",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,gradienthelper,color,colors,gradient,palette,displayio,shape,display",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/54/f8/59c626caf47ba43caca8dd1f5ceca7dc6c502364ef65355121776b870823/foamyguy-circuitpython-gradienthelper-1.0.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/foamyguy-circuitpython-gradienthelper/badge/?version=latest\n :target: https://circuitpython-gradienthelper.readthedocs.io/\n :alt: Documentation Status\n\n\n\n.. image:: https://img.shields.io/discord/327254708534116352.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n\n.. image:: https://github.com/Foamyguy/Foamyguy_CircuitPython_GradientHelper/workflows/Build%20CI/badge.svg\n :target: https://github.com/Foamyguy/Foamyguy_CircuitPython_GradientHelper/actions\n :alt: Build Status\n\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\nTools for generating color gradient palettes and sha\n\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://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.Installing from PyPI\n=====================\n\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/Foamyguy-circuitpython-gradienthelper/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install Foamyguy-circuitpython-gradienthelper\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install Foamyguy-circuitpython-gradienthelper\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 .env/bin/activate\n pip3 install Foamyguy-circuitpython-gradienthelper\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n circup install gradienthelper\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\n.. code-block:: python\n\n from foamyguy_gradienthelper import (\n linear_gradient,\n polylinear_gradient,\n bezier_gradient,\n )\n\n def print_palette(palette):\n out_str = \"[\"\n for color in palette:\n out_str = f\"{out_str}{color:#0{8}x}, \"\n out_str = out_str[:-2]\n out_str = f\"{out_str}]\"\n print(out_str)\n\n linear_colors = linear_gradient(0xFF0000, 0x0000FF, 10)\n print_palette(linear_colors)\n\n polylinear_colors = polylinear_gradient((0x00FF00, 0xFFFF00, 0x00FFFF), 30)\n print_palette(polylinear_colors)\n\n bezier_colors = bezier_gradient((0xFF00FF, 0x00FFFF, 0x00FF00), 100)\n print_palette(bezier_colors)\n\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://circuitpython-gradienthelper.readthedocs.io/>`_.\n\nFor information on building library documentation, please check out\n`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/Foamyguy/Foamyguy_CircuitPython_GradientHelper/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Tools for generating color gradient palettes and sha",
"version": "1.0.0",
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"gradienthelper",
"color",
"colors",
"gradient",
"palette",
"displayio",
"shape",
"display"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "bce040f91bdecc6ed62548de3fde12f3",
"sha256": "83364e15edb12640f56c6f77e46e36639ee87f3c75c73eeb121e6176c9ad13a0"
},
"downloads": -1,
"filename": "foamyguy_circuitpython_gradienthelper-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bce040f91bdecc6ed62548de3fde12f3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5750,
"upload_time": "2022-12-23T15:56:59",
"upload_time_iso_8601": "2022-12-23T15:56:59.281067Z",
"url": "https://files.pythonhosted.org/packages/cc/f9/f9e5b721ebb87572d0d5807234d6b2df28be5db4aa7c59ffbcf62a123f06/foamyguy_circuitpython_gradienthelper-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "1f1bbd93964b830214e78b5cf1f51b3b",
"sha256": "461e602a6a195dae8da9e46707a4cef5f28d4004d6fb3acb7743c7e54d8581a9"
},
"downloads": -1,
"filename": "foamyguy-circuitpython-gradienthelper-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "1f1bbd93964b830214e78b5cf1f51b3b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 28998,
"upload_time": "2022-12-23T15:57:01",
"upload_time_iso_8601": "2022-12-23T15:57:01.083950Z",
"url": "https://files.pythonhosted.org/packages/54/f8/59c626caf47ba43caca8dd1f5ceca7dc6c502364ef65355121776b870823/foamyguy-circuitpython-gradienthelper-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-23 15:57:01",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "foamyguy-circuitpython-gradienthelper"
}
JSON