Metadata-Version: 2.1
Name: chroma-craft
Version: 0.1.0
Summary: A simple library that automates the generation of distinguishable colors paletes, and offers other color tools.
Author-email: Felix-Pedro <croma_craft@auneria.com>
License: MIT License
        
        Copyright (c) 2023 Felix-Pedro
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/Felix-Pedro/ChromaCraft
Keywords: color,colors,distinguish,distinguishable,different,unique,palette,distinct,differenciable,color palette,color palettes,color palette generator,distinct colors,distinct color,distinguishable colors,unique color palette,unique color palettes,unique colors
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: tqdm
Requires-Dist: seaborn
Provides-Extra: dev
Requires-Dist: black; extra == "dev"
Requires-Dist: pip-tools; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: twine; extra == "dev"

# ChromaCraft

ChromaCraft is a Python package for generating and visualizing distinguishable color palettes. It provides tools for generating color sets with specific criteria, such as minimum and maximum color differences. This package is particularly useful for data visualization and design tasks where a set of visually distinct colors is needed.

## Installation

To install you can simply use `pip`

```bash
pip install chroma-craft´´
```

# Usage

Import the ChromaCraft package and use its functions to generate and visualize color palettes.

```python
import chroma_craft as cc
import seaborn as sns

# Set the Seaborn style for better visualization
sns.set_style('whitegrid')

# Generate a list of distinguishable colors
n = 24  # Number of colors to generate
min_color_diff = 0.25  # Minimum color difference
max_color_diff = 1.2   # Maximum color difference
colors = cc.generate_distinguishable_colors(n, min_color_diff, max_color_diff, hexa=True)

# Plot the color palette
cc.plot_color_palette(colors)
```

![first_example_palette](https://raw.githubusercontent.com/Felix-Pedro/ChromaCraft/main/doc/images/example_pallete_1.png)

```python
print(colors)
['#c6dd6d', '#51e3fb', '#6c8c98', '#80f79e', '#cd4e76', '#09fe8a', '#2e3c0c', '#17229b',
'#d6c1b1', '#82a243', '#843520', '#7a039f', '#21a371', '#d4c00d', '#7c90dd', '#537e02',
'#66495e', '#342147', '#ef7b43', '#b90d76', '#c39b7e', '#8adf15', '#1556cc', '#3bde54']
```

# Debug
Here's an example of how debug information is shown:

```python
import chroma_craft as cc
import seaborn as sns

# Set the Seaborn style for better visualization
sns.set_style('whitegrid')

# Number of colors to generate
n = 3

# Minimum and maximum color difference
min_color_diff = 0.25
max_color_diff = 1.2

# Generate a list of distinguishable colors
colors = cc.generate_distinguishable_colors(n, min_color_diff,
                                            max_color_diff, debug=True, hexa=False)

# Plot the color palette
cc.plot_color_palette(colors)
```

![debug](https://raw.githubusercontent.com/Felix-Pedro/ChromaCraft/main/doc/images/debug.png)
![debug-1](https://raw.githubusercontent.com/Felix-Pedro/ChromaCraft/main/doc/images/debug-1.png)
![debug-2](https://raw.githubusercontent.com/Felix-Pedro/ChromaCraft/main/doc/images/debug-2.png)
![debug-3](https://raw.githubusercontent.com/Felix-Pedro/ChromaCraft/main/doc/images/debug-3.png)
![debug-4](https://raw.githubusercontent.com/Felix-Pedro/ChromaCraft/main/doc/images/debug-5.png)
![debug-5](https://raw.githubusercontent.com/Felix-Pedro/ChromaCraft/main/doc/images/debug-6.png)

![debug-6](https://raw.githubusercontent.com/Felix-Pedro/ChromaCraft/main/doc/images/debug-7.png)

## Author

ChromaCraft was created by Felix. If you find this package useful or have any feedback, please feel free to reach out to croma_craft@auneria.com.

- GitHub: [Felix-Pedro](https://github.com/Felix-Pedro)
- LinkedIn: [Felix](https://www.linkedin.com/in/pedro-henrique-felix-gomes/)
