Skip to content

Commit

Permalink
Merge pull request #476 from jbouffard/feature/how-to-test
Browse files Browse the repository at this point in the history
How to Run the Tests Section Added to the README
  • Loading branch information
Jacob Bouffard committed Aug 25, 2017
2 parents 5f366a9 + bfa7c9d commit 174e80a
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -319,6 +319,26 @@ These can be used regardless of installation method. However, if installed
through ``pip``, then the jar must be downloaded first or these commands
will not work.


Running GeoPySpark Tests
-------------------------

GeoPySpark uses the `pytest <https://docs.pytest.org/en/latest/>`_ testing
framework to run its unittests. If you wish to run GeoPySpark's unittests,
then you must first clone this repository to your machine. Once complete,
go to the root of the library and run the following command:

.. code:: console
pytest
This will then run all of the tests present in the GeoPySpark library.

**Note**: The unittests require additional dependencies in order to pass fully.
`pyrproj <https://pypi.python.org/pypi/pyproj?>`_, `colortools <https://pypi.python.org/pypi/colortools/0.1.2>`_,
and `matplotlib <https://pypi.python.org/pypi/matplotlib/2.0.2>`_ (only for >=Python3.4) are needed to
ensure that all of the tests pass.

Make Targets
^^^^^^^^^^^^

Expand Down

0 comments on commit 174e80a

Please sign in to comment.