README.rst 3.44 KB
Newer Older
MGB's avatar
MGB committed
1
.. image:: http://img.shields.io/badge/docs-stable-yellow.png
mgbarrero's avatar
mgbarrero committed
2
   :target: http://pythonhosted.org/bob.db.kboc16/index.html
MGB's avatar
MGB committed
3
.. image:: http://img.shields.io/badge/docs-latest-orange.png
mgbarrero's avatar
mgbarrero committed
4
   :target: https://www.idiap.ch/software/bob/docs/latest/bioidiap/bob.db.kboc16/master/index.html
5
6
7
8
.. image:: https://travis-ci.org/bioidiap/bob.db.kboc16.svg?branch=master
   :target: https://travis-ci.org/bioidiap/bob.db.kboc16?branch=master
.. image:: https://coveralls.io/repos/bioidiap/bob.db.kboc16/badge.svg?branch=master
   :target: https://coveralls.io/r/bioidiap/bob.db.kboc16?branch=master
MGB's avatar
MGB committed
9
.. image:: https://img.shields.io/badge/github-master-0000c0.png
mgbarrero's avatar
mgbarrero committed
10
11
12
13
14
   :target: https://github.com/bioidiap/bob.db.kboc16/tree/master
.. image:: http://img.shields.io/pypi/v/bob.db.kboc16.png
   :target: https://pypi.python.org/pypi/bob.db.kboc16
.. image:: http://img.shields.io/pypi/dm/bob.db.kboc16.png
   :target: https://pypi.python.org/pypi/bob.db.kboc16
MGB's avatar
MGB committed
15
16
17
18
19
20


==================
 KBOC16 Database
==================

MGB's avatar
MGB committed
21
This package contains the access API and descriptions for the `KBOC16
MGB's avatar
MGB committed
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
Database`_.

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:

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

2. You can manually download and install this package using commands like
   ``easy_install`` or ``pip``.

The package is available in two different distribution formats:

1. You can download it from `PyPI <http://pypi.python.org/pypi>`_, or

2. You can download it in its source form from `its git repository
   <https://github.com/mgbarrero/bob.db.KBOC16>`_. When you download the
   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
   ``a`` you can run in `dummy` mode and only download the raw data files for
   the database once you are happy with your setup.

You can mix and match points 1/2 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=[
      ...
mgbarrero's avatar
mgbarrero committed
63
      "bob.db.kboc16",
MGB's avatar
MGB committed
64
65
66
    ],

Proceed normally with your ``boostrap/buildout`` steps and you should be all
mgbarrero's avatar
mgbarrero committed
67
set. That means you can now import the ``bob.db.kboc16 `` namespace into your scripts.
MGB's avatar
MGB committed
68
69
70
71
72
73
74
75
76
77
78
79
80
81

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 = ...
mgbarrero's avatar
mgbarrero committed
82
         bob.db.kboc16
MGB's avatar
MGB committed
83
84

  [sources]
mgbarrero's avatar
mgbarrero committed
85
  bob.db.KBOC16 = git https://github.com/mgbarrero/bob.db.kboc16.git
MGB's avatar
MGB committed
86
  ...