README.rst 2.84 KB
Newer Older
André Anjos's avatar
André Anjos committed
1 2 3 4 5 6
========================
 Replay Attack Database
========================

This package contains the access API and descriptions for the `Replay Attack
Database <http://www.idiap.ch/dataset/replayattack/>`_. The actual raw data for
André Anjos's avatar
André Anjos committed
7 8 9
the database should be downloaded from the original URL. This package only
contains the `Bob <http://www.idiap.ch/software/bob/>`_ accessor methods to use
the DB directly from python, with our certified protocols.
André Anjos's avatar
André Anjos committed
10 11 12 13 14

You would normally not install this package unless you are maintaining it. What
you would do instead is to tie it in at the package you need to **use** it.
There are a few ways to achieve this:

André Anjos's avatar
André Anjos committed
15 16 17 18 19 20
1. You can add this package as a requirement at the ``setup.py`` for your own
   `satellite package
   <https://github.com/idiap/bob/wiki/Virtual-Work-Environments-with-Buildout>`_
   or to your Buildout ``.cfg`` file, if you prefer it that way. With this
   method, this package gets automatically downloaded and installed on your
   working environment, or
André Anjos's avatar
André Anjos committed
21

André Anjos's avatar
André Anjos committed
22 23
2. You can manually download and install this package using commands like
   ``easy_install`` or ``pip``.
André Anjos's avatar
André Anjos committed
24 25 26

The package is available in two different distribution formats:

André Anjos's avatar
André Anjos committed
27
1. You can download it from `PyPI <http://pypi.python.org/pypi>`_, or
André Anjos's avatar
André Anjos committed
28

André Anjos's avatar
André Anjos committed
29
2. You can download it in its source form from `its git repository
André Anjos's avatar
André Anjos committed
30
   <https://github.com/bioidiap/xbob.db.replay>`_. When you download the
André Anjos's avatar
André Anjos committed
31 32 33
   version at the git repository, you will need to run a command to recreate
   the backend SQLite file required for its operation. This means that the
   database raw files must be installed somewhere in this case. With option
André Anjos's avatar
André Anjos committed
34
   ``1`` you can run in `dummy` mode and only download the raw data files for
André Anjos's avatar
André Anjos committed
35
   the database once you are happy with your setup.
André Anjos's avatar
André Anjos committed
36 37 38 39 40 41 42 43 44 45 46 47 48 49

You can mix and match points 1/2 and a/b above based on your requirements. Here
are some examples:

Modify your setup.py and download from PyPI
===========================================

That is the easiest. Edit your ``setup.py`` in your satellite package and add
the following entry in the ``install_requires`` section (note: ``...`` means
`whatever extra stuff you may have in-between`, don't put that on your
script)::

    install_requires=[
      ...
André Anjos's avatar
André Anjos committed
50
      "xbob.db.replay",
André Anjos's avatar
André Anjos committed
51 52 53
    ],

Proceed normally with your ``boostrap/buildout`` steps and you should be all
André Anjos's avatar
André Anjos committed
54
set. That means you can now import the ``xbob.db.replay`` namespace into your scripts.
André Anjos's avatar
André Anjos committed
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69

Modify your buildout.cfg and download from git
==============================================

You will need to add a dependence to `mr.developer
<http://pypi.python.org/pypi/mr.developer/>`_ to be able to install from our
git repositories. Your ``buildout.cfg`` file should contain the following
lines::

  [buildout]
  ...
  extensions = mr.developer
  auto-checkout = *
  eggs = bob
         ...
André Anjos's avatar
André Anjos committed
70
         xbob.db.replay
André Anjos's avatar
André Anjos committed
71 72

  [sources]
André Anjos's avatar
André Anjos committed
73
  xbob.db.replay = git https://github.com/bioidiap/xbob.db.replay.git
André Anjos's avatar
André Anjos committed
74
  ...