Development¶
Installation¶
WhatColorIsX can be installed for development as normal:
- clone the GitHub repo
- run
python setup.py develop
- install dev dependencies using
pip install -r requirements_dev.txt
.
Roadmap¶
Some ideas:
improve relevance of colour value
- discard/differentiate background
- look at center of image
return list of n colour suggestions
- use multiple images (heavy internet, light computation)
- use clustering/peak detection (light internet, heavy computation/installation size)
Guidelines¶
Please ensure any new code you write:
is documented
- has docstrings in the source code
- is added to the
docs
(prefrably using autodoc)sphinx-build -b html . ./_build
to check html outputis covered by tests
- write tests and add them to
tests
- run tests using
nosetests
orcoverage run source=WhatColorIsX.py setup.py test
- check coverage using
coverage report
Pull Requests on GitHub are always welcome!