Sample Python application that demonstrate the possibility to find and mark text sequence in web page

To install dependencies run:

pip install -r requirements.txt

To install highlighter:

pip install -e .

To run highlighter app (On Windows use set instead of export):

export FLASK_APP=highlighter
flask run

then go to localhost:5000

The application contains tests. To run tests:

pytest -v

Code must satisfy PEP008 code style requirements

pylint -r y **/*.py

• Create dev branch. You can do it either via Pycharm' menu (see the Pycharm how to for details) or via terminal like this:

git checkout master
git pull
git checkout -b dev

• Add an implementation to methods in the __init__.py module that covers the demands
  • markup_text
  • highlight_text
• Add tests to the implemented methods in the tests/test_highlighter.py module. You can find examples of tests on Flask testing howto page.
• Run tests
• Run code check
• Commit and push your local changes to the remote git repository. You can do it either via Pycharm view (Ctrl + K) or via terminal

git commit -a -m 'type your commit message here'
git push origin dev

• Create MR (merge request). See how to do it here
• Send the link to the MR to your reviewer