Metadata-Version: 1.2
Name: audformat
Version: 0.10.0
Summary: Python implementation of audformat
Home-page: https://github.com/audeering/audformat/
Author: Johannes Wagner, Hagen Wierstorf
Author-email: jwagner@audeering.com, hwierstorf@audeering.com
License: MIT
Project-URL: Documentation, https://audeering.github.io/audformat/
Description: =========
        audformat
        =========
        
        |tests| |coverage| |docs| |python-versions| |license|
        
        Specification and reference implementation of **audformat**.
        
        audformat stores media data,
        such as audio or video,
        together with corresponding annotations
        in a pre-defined way.
        This makes it easy to combine or replace databases
        in machine learning projects.
        
        An audformat database is a folder
        that contains media files
        together with a header YAML file
        and one or several files storing the annotations.
        The database is represented as an ``audformat.Database`` object
        and can be loaded with ``audformat.Database.load()``
        or written to disk with ``audformat.Database.save()``.
        
        Have a look at the installation_ and usage_ instructions
        and the `format specifications`_ as a starting point.
        
        
        .. _installation: https://audeering.github.io/audformat/install.html
        .. _usage: https://audeering.github.io/audformat/create-database.html
        .. _format specifications: https://audeering.github.io/audformat/data-introduction.html
        
        
        .. badges images and links:
        .. |tests| image:: https://github.com/audeering/audformat/workflows/Test/badge.svg
            :target: https://github.com/audeering/audformat/actions?query=workflow%3ATest
            :alt: Test status
        .. |coverage| image:: https://codecov.io/gh/audeering/audformat/branch/master/graph/badge.svg?token=1FEG9P5XS0
            :target: https://codecov.io/gh/audeering/audformat/
            :alt: code coverage
        .. |docs| image:: https://img.shields.io/pypi/v/audformat?label=docs
            :target: https://audeering.github.io/audformat/
            :alt: audformat's documentation
        .. |license| image:: https://img.shields.io/badge/license-MIT-green.svg
            :target: https://github.com/audeering/audformat/blob/master/LICENSE
            :alt: audformat's MIT license
        .. |python-versions| image:: https://img.shields.io/pypi/pyversions/audformat.svg
            :target: https://pypi.org/project/audformat/
            :alt: audformats's supported Python versions
        
        Changelog
        =========
        
        All notable changes to this project will be documented in this file.
        
        The format is based on `Keep a Changelog`_,
        and this project adheres to `Semantic Versioning`_.
        
        
        Version 0.10.0 (2021-03-18)
        ---------------------------
        
        * Added: ``audformat.Database.update()``
        * Added: ``audformat.Table.update()``
        * Added: ``overwrite`` argument to ``audformat.utils.concat()``
        * Changed: result of ``audformat.Table.__add__()`` is no longer assigned to a ``audformat.Database``
        
        
        Version 0.9.8 (2021-02-23)
        --------------------------
        
        * Added: ``audformat.Database.license``
        * Added: ``audformat.Database.license_url``
        * Added: ``audformat.Database.author``
        * Added: ``audformat.Database.organization``
        * Added: ``audformat.utils.intersect()`` for index objects
        * Added: ``audformat.utils.union()`` for index objects
        * Changed: ``Database.load()`` raises error if table file missing
        * Changed: forbid duplicates in ``audformat`` conform indices
        * Fixed: ``audformat.Table.__add__()`` returned wrong values
          for some index combinations
        
        
        Version 0.9.7 (2021-02-01)
        --------------------------
        
        * Added: ``update_other_formats`` argument to ``audformat.Table.save()``
          to make sure existing files in other formats are updated as well
        * Changed: use ``round_trip`` argument when loading CSV files
          to ensure dataframes are equal after storing and loading again
        
        
        Version 0.9.6 (2021-01-28)
        --------------------------
        
        * Fixed: implemented ``audformat.Database.__eq__`` and return ``True``
          for identical databases
        
        
        Version 0.9.5 (2021-01-14)
        --------------------------
        
        * Changed: use nullable Pandas' type ``'boolean'`` for ``bool`` schemes
        * Fixed: ``Scheme.draw()`` generates boolean values if scheme is ``bool``
        
        
        Version 0.9.4 (2021-01-11)
        --------------------------
        
        * Changed: add arguments ``num_workers`` and ``verbose`` to
          ``audformat.Database.load()``
        
        
        Version 0.9.3 (2021-01-07)
        --------------------------
        
        * Fixed: avoid sphinx syntax in CHANGELOG
        
        
        Version 0.9.2 (2021-01-07)
        --------------------------
        
        * Changed: add arguments ``num_workers`` and ``verbose`` to
          ``audformat.Database.drop_files()``,
          ``audformat.Database.map_files()``,
          ``audformat.Database.pick_files()``,
          ``audformat.Database.save()``
        * Changed: ``audformat.segmented_index()``
          support ``int`` and ``float``, which will be interpreted as seconds
        * Fixed: ``audformat.utils.to_segmented_index()``
          returns correct index type for ``NaT``
        
        
        Version 0.9.1 (2020-12-21)
        --------------------------
        
        * Fixed: add column name to HTML Series output in docs
        * Fixed: removed mentioning of
          ``NotConformToUnifiedFormat`` error
          and ``RedundantArgumentError`` error
        * Fixed: add missing errors to docstring
          of ``audformat.Table.set()``
          and ``audformat.Column.set()``
        
        
        Version 0.9.0 (2020-12-18)
        --------------------------
        
        * Added: initial release public release
        
        
        .. _Keep a Changelog:
            https://keepachangelog.com/en/1.0.0/
        .. _Semantic Versioning:
            https://semver.org/spec/v2.0.0.html
        
Keywords: audio,database,annotation
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Scientific/Engineering
