White Brush is a tool for enhancing hand-written notes.

Branch	Status	Information
master

git clone git@github.com:lukasbindreiter/white-brush.git
cd white-brush
python setup.py install

white-brush test_images/01.png

If you are on windows, you can also register the program as context menu entry, allowing you to right click on an image to enhance it.

python setup.py register_menu_entry

1. Checkout the repository
2. Install the requirements

pipenv install --dev

3. Run the tests

pytest
# to output a code coverage report
pytest --cov=white_brush --cov-report html

Instead of installing the pipenv dependencies on your system, you can also use the Dockerfile which is provided in the root directory:

docker build -t white-brush .
docker run -it --rm white-brush python -m white_brush test_images/01.jpg 01_enhanced.jpg

Or to start a jupyter to which you can connect to take a look at the provided notebooks:

# First use docker build command above, then
docker run -d --rm -p 8888:8888 white_brush

Then go ahead and connect to http://localhost:8888 in your browser.