Commit c0b1e5b4 authored by André Anjos's avatar André Anjos 💬 Committed by Samuel GAIST

Updated README with badges and a simple description

parent ae260583
......@@ -20,42 +20,47 @@
.. You should have received a copy of the GNU Affero Public License along ..
.. with the BEAT platform. If not, see http://www.gnu.org/licenses/. ..
============================================
Biometrics Evaluation and Testing Platform
============================================
This package contains the source code for a python-based backend for the BEAT
platform.
It contains the minimum amount of code needed to run an algorithm or serve
data from a dataset. It is designed to be installed in a container.
The ``beat.core`` package extends the functionalities of this one (for
instance, it adds thorough validation of each user contribution, whereas
``beat.backend.python`` assumes that an invalid contribution will never
reach the container).
For this reason (and to keep ``beat.backend.python`` as small as possible),
all the unit tests are located in ``beat.core``.
.. image:: https://img.shields.io/badge/docs-stable-yellow.svg
:target: https://www.idiap.ch/software/beat/docs/beat/beat.backend.python/stable/index.html
.. image:: https://img.shields.io/badge/docs-latest-orange.svg
:target: https://www.idiap.ch/software/beat/docs/beat/beat.backend.python/master/index.html
.. image:: https://gitlab.idiap.ch/beat/beat.backend.python/badges/master/build.svg
:target: https://gitlab.idiap.ch/beat/beat.backend.python/commits/master
.. image:: https://gitlab.idiap.ch/beat/beat.backend.python/badges/master/coverage.svg
:target: https://gitlab.idiap.ch/beat/beat.backend.python/commits/master
.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg
:target: https://gitlab.idiap.ch/beat/beat.backend.python
.. image:: https://img.shields.io/pypi/v/beat.backend.python.svg
:target: https://pypi.python.org/pypi/beat.backend.python
=========================
Python Backend for BEAT
=========================
This package part of BEAT_, an open-source evaluation platform for data science
algorithms and workflows. It contains the minimum amount of code needed to run
user algorithms or inject data in toolchains from locally installed raw data
assets.
Installation
------------
Really easy, with ``zc.buildout``::
Complete BEAT's `installation`_ instructions. Then, to install this package,
run::
$ python bootstrap-buildout.py
$ ./bin/buildout
$ conda install beat.backend.python
These 2 commands should download and install all non-installed dependencies and
get you a fully operational test and development environment.
Contact
-------
Documentation
-------------
For questions or reporting issues to this software package, contact our
development `mailing list`_.
To build the documentation, just do::
$ ./bin/sphinx-apidoc --separate -d 2 --output=doc/api beat
$ ./bin/sphinx-build doc sphinx
.. Place your references here:
.. _beat: https://www.idiap.ch/software/beat
.. _installation: https://www.idiap.ch/software/beat/install
.. _mailing list: https://www.idiap.ch/software/beat/discuss
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment