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/buildout

These 2 commands should download and install all non-installed dependencies and get you a fully operational test and development environment.

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 sphinx

Testing

After installation, it is possible to run our suite of unit tests. To do so, use nose:

$ ./bin/nosetests -sv

$ export BEAT_CMDLINE_TEST_PLATFORM="http://example.com/platform/"
$ ./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.cmdline

To 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=htmlcov

Our documentation is also interspersed with test units. You can run them using sphinx:

$ ./bin/sphinx -b doctest doc sphinx

Development

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.data

This will allow you to dump and print the profiling statistics as you may find fit.