Metadata-Version: 2.1
Name: color-palette-at
Version: 0.1.3
Summary: Library that allows to get a color palette from an image.
Home-page: UNKNOWN
Author: Adam Tabaczyński
Author-email: adam.tabaczynski96@gmail.com
License: MIT
Keywords: color color_palette colors
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: Development Status :: 3 - Alpha
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE.txt

# color_palette_at

color_palette_at is a Python library that returns a list of most often occuring colors in the given image.  
You can define number of colors and color values format that will be returned.  
Currently supported formats:  
hex

## Installation

Use the package manager [pip](https://pip.pypa.io/en/stable/) to install color_palette_at:

```bash
pip install color_palette_at
```

## Usage

```python
from color_palette_at import ColorPalette

print(ColorPalette('path/to/an/image.jpg', 5, 'hex'))
# Expected result:
# ['#e0bb1e', '#c79121', '#b37027', '#ba6432', '#851f16']
```

## Tests
You will need a [pytest](https://pypi.org/project/pytest/) library to run tests. After installation of said module, run this command in a directory where the color_palette_at library is located:
```
pytest
```
To run all the tests.

## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License
[MIT](https://choosealicense.com/licenses/mit/)

