README.rst 3.44 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
.. image:: https://travis-ci.org/bioidiap/bob.db.replay.svg?branch=master
   :target: https://travis-ci.org/bioidiap/bob.db.replay
.. image:: https://coveralls.io/repos/bioidiap/bob.db.replay/badge.png
   :target: https://coveralls.io/r/bioidiap/bob.db.replay
.. image:: http://img.shields.io/github/tag/bioidiap/bob.db.replay.png
   :target: https://github.com/bioidiap/bob.db.replay
.. image:: http://img.shields.io/pypi/v/bob.db.replay.png
   :target: https://pypi.python.org/pypi/bob.db.replay
.. image:: http://img.shields.io/pypi/dm/bob.db.replay.png
   :target: https://pypi.python.org/pypi/bob.db.replay

André Anjos's avatar
André Anjos committed
12
13
14
15
16
17
========================
 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
18
19
20
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
21
22
23
24
25

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
26
27
28
29
30
31
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
32

André Anjos's avatar
André Anjos committed
33
34
2. You can manually download and install this package using commands like
   ``easy_install`` or ``pip``.
André Anjos's avatar
André Anjos committed
35
36
37

The package is available in two different distribution formats:

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

André Anjos's avatar
André Anjos committed
40
2. You can download it in its source form from `its git repository
André Anjos's avatar
André Anjos committed
41
   <https://github.com/bioidiap/xbob.db.replay>`_. When you download the
André Anjos's avatar
André Anjos committed
42
43
44
   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
45
   ``1`` you can run in `dummy` mode and only download the raw data files for
André Anjos's avatar
André Anjos committed
46
   the database once you are happy with your setup.
André Anjos's avatar
André Anjos committed
47
48
49
50
51
52
53
54
55
56
57
58
59
60

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
61
      "xbob.db.replay",
André Anjos's avatar
André Anjos committed
62
63
64
    ],

Proceed normally with your ``boostrap/buildout`` steps and you should be all
André Anjos's avatar
André Anjos committed
65
set. That means you can now import the ``xbob.db.replay`` namespace into your scripts.
André Anjos's avatar
André Anjos committed
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

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
81
         xbob.db.replay
André Anjos's avatar
André Anjos committed
82
83

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