Metadata-Version: 2.1
Name: colour-sort
Version: 0.1.1
Summary: A tool to generate images using all rgb colours with no duplicates.
Home-page: https://github.com/buckley-w-david/colour_sort
License: MIT
Author: David Buckley
Author-email: buckley.w.david@gmail.com
Requires-Python: >=3.6.7
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Provides-Extra: cli
Requires-Dist: importlib_resources (>=1.0,<2.0); extra == "cli"
Requires-Dist: numpy (>=1.17,<2.0)
Requires-Dist: pillow (>=6.2,<7.0); extra == "cli"
Project-URL: Repository, https://github.com/buckley-w-david/colour_sort
Description-Content-Type: text/markdown

## Colour Sort 

Generating Images using all 256<sup>3</sup> RGB colours, inspired by https://allrgb.com/

### Technique

To generate a re-coloured image, the source image's pixel data is sorted (using one of several different sorting modes) using numpy's `argsort` function, giving us a mapping from the original to the sorted version. This mapping is then used to "unsort" an array of all 256<sup>3</sup> colours that in sorted order. The result of this operation is then written out as our result.

### Installing

Go get [poetry](https://poetry.eustace.io/).
```
$ poetry install
```

### Running

Once the tool has been installed, it can be ran with the following command
```
$ colour generate --help
usage: colour generate [-h] [--sort {brightness,avg,rgb,rbg,brg,bgr,grb,gbr}]
                       infile outfile

positional arguments:
  infile
  outfile

optional arguments:
  -h, --help            show this help message and exit
  --sort {brightness,avg,rgb,rbg,brg,bgr,grb,gbr}

$ colour verify --help
usage: colour verify [-h] infile

positional arguments:
  infile

optional arguments:
  -h, --help  show this help message and exit
```

