Biometrics Evaluation and Testing Platform
This package contains the source code for a python-based backend for the BEAT platform.
Installation
Really easy, with zc.buildout
:
$ python bootstrap-buildout.py
$ ./bin/buildout
These 2 commands should download and install all non-installed dependencies and get you a fully operational test and development environment.
Note
If you are on the Idiap filesystem, you may use
/idiap/project/beat/environments/staging/usr/bin/python
to bootstrap this
package instead. It contains the same setup deployed at the final BEAT
machinery.
Documentation
To build the documentation, just do:
$ ./bin/sphinx-apidoc --separate -d 2 --output=doc/api beat/backend/python
$ ./bin/sphinx-build doc sphinx
Testing
After installation, it is possible to run our suite of unit tests. To do so,
use nose
:
$ ./bin/nosetests -sv
If you want to skip slow tests (at least those pulling stuff from our servers) or executing lengthy operations, just do:
$ ./bin/nosetests -sv -a '!slow'
To measure the test coverage, do the following:
$ ./bin/nosetests -sv --with-coverage --cover-package=beat.backend.python
To produce an HTML test coverage report, at the directory ./htmlcov, do the following:
$ ./bin/nosetests -sv --with-coverage --cover-package=beat.backend.python --cover-html --cover-html-dir=htmlcov
Our documentation is also interspersed with test units. You can run them using sphinx:
$ ./bin/sphinx -b doctest doc sphinx