Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 7 additions & 37 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
audb
====

|tests| |coverage| |docs| |python-versions| |license|
|docs| | |python-versions| | |license| | |paper|


**audb** manages your annotated media files.

Expand All @@ -25,47 +26,16 @@ e.g. if you just want to download the test set.
Have a look at the installation_ and quickstart_ instructions.


Citation
--------

If you want to cite **audb**, you can refer to our paper_:

.. code-block:: bibtex

@article{wierstorf2023audb,
title={audb -- Sharing and Versioning of Audio and Annotation Data in Python},
author={Hagen Wierstorf
and Johannes Wagner
and Florian Eyben
and Felix Burkhardt
and Bj{\"o}rn W. Schuller},
journal={arXiv preprint arXiv:2303.00645},
year={2023},
}


.. _Artifactory: https://jfrog.com/artifactory/
.. _common format: https://audeering.github.io/audformat/
.. _installation: https://audeering.github.io/audb/install.html
.. _MinIO: https://min.io
.. _paper: https://arxiv.org/abs/2303.00645
.. _quickstart: https://audeering.github.io/audb/quickstart.html
.. _S3: https://aws.amazon.com/s3/


.. badges images and links:
.. |tests| image:: https://github.com/audeering/audb/workflows/Test/badge.svg
:target: https://github.com/audeering/audb/actions?query=workflow%3ATest
:alt: Test status
.. |coverage| image:: https://codecov.io/gh/audeering/audb/branch/main/graph/badge.svg?token=drrULW8vEG
:target: https://codecov.io/gh/audeering/audb/
:alt: code coverage
.. |docs| image:: https://img.shields.io/pypi/v/audb?label=docs
:target: https://audeering.github.io/audb/
:alt: audb's documentation
.. |license| image:: https://img.shields.io/badge/license-MIT-green.svg
:target: https://github.com/audeering/audb/blob/main/LICENSE
:alt: audb's MIT license
.. |python-versions| image:: https://img.shields.io/pypi/pyversions/audb.svg
:target: https://pypi.org/project/audb/
:alt: audbs's supported Python versions
.. header links:
.. |docs| replace:: `📚Documentation <https://audeering.github.io/audb/>`__
.. |license| replace:: `📜 MIT license <https://github.com/audeering/audb/blob/main/LICENSE>`__
.. |python-versions| replace:: `🐍 Python 3.9, 3.10, 3.11, 3.12, 3.13 <https://pypi.org/project/audb/>`__
.. |paper| replace:: `📑 Paper <https://arxiv.org/abs/2303.00645/>`__
Loading