From f86e79aa8592f3903570c45efad7a66c8c9a1fa5 Mon Sep 17 00:00:00 2001 From: ines Date: Fri, 6 Apr 2018 16:32:36 +0200 Subject: [PATCH] Update README section on tests (resolves #2191) --- README.rst | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/README.rst b/README.rst index a50d9bd70..4013aa210 100644 --- a/README.rst +++ b/README.rst @@ -308,18 +308,20 @@ VS 2010 (Python 3.4) and VS 2015 (Python 3.5). Run tests ========= -spaCy comes with an `extensive test suite `_. First, find out where -spaCy is installed: +spaCy comes with an `extensive test suite `_. In order to run the +tests, you'll usually want to clone the repository and build spaCy from source. +This will also install the required development dependencies and test utilities +defined in the ``requirements.txt``. + +Alternatively, you can find out where spaCy is installed and run ``pytest`` on +that directory. Don't forget to also install the test utilities via spaCy's +``requirements.txt``: .. code:: bash python -c "import os; import spacy; print(os.path.dirname(spacy.__file__))" - -Then run ``pytest`` on that directory. The flags ``--vectors``, ``--slow`` -and ``--model`` are optional and enable additional tests: - -.. code:: bash - - # make sure you are using recent pytest version - python -m pip install -U pytest + pip install -r path/to/requirements.txt python -m pytest + +See `the documentation `_ for more details and +examples.