function signatures.
The downside is this seems to be Linux only currently. This wrapper
-immediately SIGABRT’s on Mac, and no one yet seems to know why. The
+immediately SIGABRT's on Mac, and no one yet seems to know why. The
other downside is that there are currently some functionality that needs
-to be “exported” from the C library for this to be fully operational.
+to be 'exported' from the C library for this to be fully operational.
For example, CTYPES does not have access to C header files, and
important constants are defined in the C header files.
Unit Testing
============
+You can unit test in docker or outside of docker.
+The preferred method (by far) is to use Docker, because it encapsulates rmr, as well as ensuring that ports that rmr opens do not conflict with the host machine
+
+::
+
+ docker build -t rmrunittestt:latest -f Dockerfile-Unit-Test .
+
+A coverage report will be shown in stdout.
+
+It is possible to run tox locally provided that rmr is intalled, and you are prepared to have the test open ports (4562) as ``rmr_init`` must succeed for the tests to proceed.
::
tox
open htmlcov/index.html
+The added benefit of the local option is that the coverage report can be viewed in html, which I find easier to read than the term coverage reort the docker build will print.
+
Installation
============