Skip to main content

Create color gradients based on list-like input data

Project description

Gradpyent, a Python Gradient Generator

Gradpyent is a Python package for generating color gradients based on list-like inputs and start/end color values. The generated gradients are ideal for data visualization, user interfaces, or anywhere you want to convert a list of values into a color gradient.

This package allows you to specify colors in a variety of formats including RGB, HTML, and KML, giving you the flexibility to match your specific needs.

The gradient generation algorithm automatically scales input values outside the range of 0-1, ensuring the generated gradient remains consistent and visually pleasing.

Table of Contents

Installation

You can install Gradpyent directly from PyPI:

pip install gradpyent

Usage

Basic usage:

from gradpyent.gradient import Gradient

# Define the start and end colors as RGB, HTML, or KML
start_color = 'rgb(255,0,0)'  # Red in RGB
end_color = '#0000ff'  # Blue in HTML

# Instantiate the gradient generator, opacity is optional (only used for KML)
gg = Gradient(gradient_start=start_color, gradient_end=end_color, opacity=1.0)

# Define the input list
input_list = [0, 0.5, 1]

# Generate the gradient
gradient = gg.get_gradient_series(series=input_list, fmt='html')

print(gradient)

Examples

Here are some more examples demonstrating how to use different color formats and list inputs:

  • RGB colors:
start_color = 'rgb(255,0,0)'  # Red
end_color = 'rgb(0,0,255)'  # Blue
input_list = [0, 0.5, 1]
  • HTML colors:
start_color = '#ff0000'  # Red
end_color = '#0000ff'  # Blue
input_list = [0, 0.5, 1]
  • KML colors:
start_color = 'ff0000ff'  # Red
end_color = 'ffff0000'  # Blue
input_list = [0, 0.5, 1]
  • Scaling input values:
start_color = 'rgb(255,0,0)'  # Red
end_color = '#0000ff'  # Blue
input_list = [-5, 0, 5, 10]  # Values outside 0-1 range
  • Jupyter notebook samples:
    • See the notebooks directory for more examples

License

This project is licensed under the terms of the MIT license. See the LICENSE.md file for details.

Code Quality

flake8p ./src

isort ./src

pydocstyle ./src

Tests

pytest --cov ./src

Enjoy the colorful world!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gradpyent-0.1.7.tar.gz (6.5 kB view hashes)

Uploaded Source

Built Distribution

gradpyent-0.1.7-py3-none-any.whl (7.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page