README.rst 2.8 KB
Newer Older
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
1
.. vim: set fileencoding=utf-8 :
2

3
.. image:: http://img.shields.io/badge/docs-stable-yellow.svg
4
   :target: https://www.idiap.ch/software/bob/docs/bob/bob/stable/index.html
5
.. image:: http://img.shields.io/badge/docs-latest-orange.svg
6
   :target: https://www.idiap.ch/software/bob/docs/bob/bob/master/index.html
7
8
9
10
.. image:: https://gitlab.idiap.ch/bob/bob/badges/master/build.svg
   :target: https://gitlab.idiap.ch/bob/bob/commits/master
.. image:: https://gitlab.idiap.ch/bob/bob/badges/master/coverage.svg
   :target: https://gitlab.idiap.ch/bob/bob/commits/master
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
11
.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg
12
   :target: https://gitlab.idiap.ch/bob/bob/commits/master
13
.. image:: http://img.shields.io/pypi/v/bob.svg
14
15
   :target: https://pypi.python.org/pypi/bob

Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
16
====================
17
 Bob
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
18
19
20
====================

Bob is a free signal-processing and machine learning toolbox originally
Amir MOHAMMADI's avatar
Amir MOHAMMADI committed
21
22
developed by the Biometrics group at the `Idiap`_ Research Institute,
Switzerland.
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
23
24
25
26

The toolbox is written in a mix of `Python`_ and `C++`_ and is designed to be
both efficient and reduce development time. It is composed of a reasonably
large number of `packages`_ that implement tools for image, audio & video
Amir MOHAMMADI's avatar
Amir MOHAMMADI committed
27
28
processing, machine learning & pattern recognition, and a lot more task
specific packages.
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
29

Amir MOHAMMADI's avatar
Amir MOHAMMADI committed
30
**Please visit our** `website`_ **for more information.**
31

Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
32

33
34
For the maintainers
-------------------
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
35

Amir MOHAMMADI's avatar
Amir MOHAMMADI committed
36
Below are some instructions for the maintainers of the package.
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
37
38


39
40
Adding/Removing a dependency package
====================================
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
41

42
43
44
To remove or add a package from bob, search for its name (or the name of a
similar package in case you are adding a new package) in this repository and
add/remove its name in appropriate places.
45
46


47
48
Releasing a new version of Bob
==============================
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
49

50
Please run::
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
51

52
53
54
55
56
57
58
59
60
61
62
63
  $ # prepare a development environment for this package
  $ buildout
  $ bin/python ./bob/script/get_versions.py requirements.txt > requirements.txt

This will give you the latest tag version of public packages release on PyPI.

* Find the same latest tag information of private packages using Gitlab tags.
  For private packages you cannot use the ``get_versions.py`` script.
* Update private-requirements.txt similar to requirements.txt
* Put the same tags in ``conda/meta.yaml`` too. You need to pin like this:
  ``bob.extension 2.4.5``.
* Tag and push.
Amir MOHAMMADI's avatar
Amir MOHAMMADI committed
64
* Remove the pins again to relax the dependencies while in master.
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
65
66
67
68
69
70
71


.. External References

.. _c++: http://www2.research.att.com/~bs/C++.html
.. _python: http://www.python.org
.. _idiap: http://www.idiap.ch
72
73
74
75
.. _packages: https://www.idiap.ch/software/bob/packages
.. _wiki: https://www.idiap.ch/software/bob/wiki
.. _bug tracker: https://www.idiap.ch/software/bob/issues
.. _installation: https://www.idiap.ch/software/bob/install
Amir MOHAMMADI's avatar
Amir MOHAMMADI committed
76
.. _website: https://www.idiap.ch/software/bob