Skip to content

Commit

Permalink
highlight with notes
Browse files Browse the repository at this point in the history
  • Loading branch information
swiesend committed Jan 17, 2019
1 parent 4f1e503 commit e03f1bc
Showing 1 changed file with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,40 +26,41 @@ For Python 3 install ``pip3``:
Library Dependencies
--------------------

Install all dependencies (locally). Make sure you have ``virtualenv`` globally on your system installed.
Install all runtime dependencies (locally) into the virtual environment.

.. note:: Make sure you have ``virtualenv`` installed globally on your system.

For Python 2::

virtualenv -p /usr/bin/python2.7 py27
source py27/bin/activate
pip install -r requirements.txt

For Python 3::

virtualenv -p /usr/bin/python3.6 py36
source py36/bin/activate
pip install -r requirements.txt

To leave a ``virtualenv`` run::

deactivate

Prebuild Dependencies
---------------------
To leave a ``virtualenv`` run:
``deactivate``

Install this dependencies globally if you don't like to build them by yourself::
.. note:: If you don't like to built the heavy weighted dependencies by yourself,
then you might want to install some prebuild version globally. Under ubuntu do:

sudo apt-get install python-levenshtein python-numpy
``sudo apt-get install python-levenshtein python-numpy``

Testing
=======

Run all tests with the built-in test discovery or with ``pytest``.

Make sure you have ``pytest`` installed with ``pip install pytest``.
.. note:: Make sure you have ``pytest`` installed with ``pip install pytest``.

built-in:
built-in testing:
``python -m unittest discover -s './tests' -p 'test_*.py'``

or with ``pytest``:
with ``pytest``:
``pytest tests``

If you want to test just some parts of the library, then one can invoke more specficic commands.
Expand Down

0 comments on commit e03f1bc

Please sign in to comment.