Biometrics Evaluation and Testing Platform
This package contains the source code for a python-based command-line client for the BEAT platform.
Dependence Status
Before checking-out sources, make sure of the project health as per table below:
| Package | Status (master branch) |
|---|---|
| beat.core |  |
| beat.cmdline (this package) |  |
Installation
Really easy, with zc.buildout:
$ python bootstrap-buildout.py
$ ./bin/buildoutThese 2 commands should download and install all non-installed dependencies and get you a fully operational test and development environment.
Note
The python shell used in the first line of the previous command set determines the python interpreter that will be used for all scripts developed inside this package.
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 beat/cmdline/test beat/cmdline/scripts
$ ./bin/sphinx-build doc sphinxTesting
After installation, it is possible to run our suite of unit tests. To do so,
use nose:
$ ./bin/nosetests -svNote
Some of the tests for our command-line toolkit require a running BEAT
platform web-server, with a compatible beat.core installed (preferably
the same). By default, these tests will be skipped. If you want to run
them, you must setup a development web server and set the environment
variable BEAT_CMDLINE_TEST_PLATFORM to point to that address. For
example:
$ export BEAT_CMDLINE_TEST_PLATFORM="http://example.com/platform/"
$ ./bin/nosetests -svIt is not adviseable to run tests against a production web server.
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.cmdlineTo produce an HTML test coverage report, at the directory ./htmlcov, do the following:
$ ./bin/nosetests -sv --with-coverage --cover-package=beat.cmdline --cover-html --cover-html-dir=htmlcovOur documentation is also interspersed with test units. You can run them using sphinx:
$ ./bin/sphinx -b doctest doc sphinxDevelopment
Profiling
In order to profile the test code, try the following:
$ ./bin/python -mcProfile -oprof.data ./bin/nosetests -sv ...This will dump the profiling data at prof.data. You can dump its contents
in different ways using another command:
$ ./bin/python -mpstats prof.dataThis will allow you to dump and print the profiling statistics as you may find fit.