automated testing done

benmaier · May 16, 2019 · 74a59a4 · 74a59a4
1 parent 2ac8846
commit 74a59a4
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 1 deletion.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -12,7 +12,8 @@ Please note we have a [code of conduct](https://github.com/benmaier/netwulf/blob
    variables, exposed ports, useful file locations and container parameters.
 3. Increase the version number in [netwulf/metadata.py](https://github.com/benmaier/netwulf/blob/master/netwulf/metadata.py) and the README.md to the new version that this
    Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
-4. You may merge the Pull Request in once you have the sign-off of one other developer, or if you 
+4. Make sure [pytest](https://docs.pytest.org/en/latest/) is installed. Run ``make test`` to run all automated tests. Post the output as a comment in your Pull Request.
+5. You may merge the Pull Request in once you have the sign-off of one other developer, or if you 
    do not have permission to do that, you may request the reviewer to merge it for you.
 
 ## Attribution

diff --git a/Makefile b/Makefile
@@ -34,3 +34,6 @@ readme:
 	sed -e "s/^\:\:/\.\. code\:\: bash/g" _README.rst > README.rst
 	rm _README.rst
 	rstcheck README.rst
+
+test:
+	pytest --cov=netwulf tests/
diff --git a/docs/about.rst b/docs/about.rst
@@ -55,6 +55,14 @@ Install
 
 Make sure to read the ``README.md`` in the `public repository`_ for notes on dependencies and installation.
 
+``netwulf`` directly depends on the following packages which will be
+installed by ``pip`` during the installation process
+
+-  ``networkx>=2.0``
+-  ``numpy>=0.14``
+-  ``matplotlib>=3.0``
+-  ``simplejson>=3.0``
+
 
 Bug reports & contributing
 --------------------------

diff --git a/tests/test_tools.py → tests/test_all.py b/tests/test_tools.py → tests/test_all.py