README.rst 2.34 KB
Newer Older
André Anjos's avatar
André Anjos committed
1 2 3 4
.. vim: set fileencoding=utf-8 :
.. Andre Anjos <andre.anjos@idiap.ch>
.. Thu 29 Aug 2013 16:07:57 CEST

André Anjos's avatar
André Anjos committed
5 6 7 8 9 10 11 12 13 14
.. image:: https://travis-ci.org/bioidiap/bob.measure.svg?branch=master
   :target: https://travis-ci.org/bioidiap/bob.measure
.. image:: https://coveralls.io/repos/bioidiap/bob.measure/badge.png
   :target: https://coveralls.io/r/bioidiap/bob.measure
.. image:: http://img.shields.io/github/tag/bioidiap/bob.measure.png
   :target: https://github.com/bioidiap/bob.measure
.. image:: http://img.shields.io/pypi/v/bob.measure.png
   :target: https://pypi.python.org/pypi/bob.measure
.. image:: http://img.shields.io/pypi/dm/bob.measure.png
   :target: https://pypi.python.org/pypi/bob.measure
André Anjos's avatar
André Anjos committed
15

André Anjos's avatar
André Anjos committed
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
=================================
 Python bindings for bob.measure
=================================

This package contains a set of Pythonic bindings for Bob's measure packages and
functionality.

Installation
------------

Install it through normal means, via PyPI or use ``zc.buildout`` to bootstrap
the package and run test units.

Documentation
-------------

You can generate the documentation for this package, after installation, using
Sphinx::

  $ sphinx-build -b html doc sphinx

This shall place in the directory ``sphinx``, the current version for the
documentation of the package.

Testing
-------

You can run a set of tests using the nose test runner::

André Anjos's avatar
André Anjos committed
45
  $ nosetests -sv bob.measure
André Anjos's avatar
André Anjos committed
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61

.. warning::

   If Bob <= 1.2.1 is installed on your python path, nose will automatically
   load the old version of the insulate plugin available in Bob, which will
   trigger the loading of incompatible shared libraries (from Bob itself), in
   to your working binary. This will cause a stack corruption. Either remove
   the centrally installed version of Bob, or build your own version of Python
   in which Bob <= 1.2.1 is not installed.

You can run our documentation tests using sphinx itself::

  $ sphinx-build -b doctest doc sphinx

You can test overall test coverage with::

André Anjos's avatar
André Anjos committed
62
  $ nosetests --with-coverage --cover-package=bob.measure
André Anjos's avatar
André Anjos committed
63 64 65 66 67 68 69

The ``coverage`` egg must be installed for this to work properly.

Development
-----------

To develop this package, install using ``zc.buildout``, using the buildout
André Anjos's avatar
André Anjos committed
70
configuration found on the root of the package::
André Anjos's avatar
André Anjos committed
71 72 73 74 75 76 77

  $ python bootstrap.py
  ...
  $ ./bin/buildout

Tweak the options in ``buildout.cfg`` to disable/enable verbosity and debug
builds.