audformat


Nameaudformat JSON
Version 1.1.2 PyPI version JSON
download
home_page
SummaryPython implementation of audformat
upload_time2024-02-02 15:22:44
maintainer
docs_urlNone
authorBahaEddine Abrougui
requires_python>=3.8
licenseMIT License Copyright (c) 2018-present audEERING GmbH and Contributors Authors: Johannes Wagner Hagen Wierstorf Baha Eddine Abrougui Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords audio database annotation
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            =========
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/main/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/main/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

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "audformat",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "audio,database,annotation",
    "author": "BahaEddine Abrougui",
    "author_email": "Hagen Wierstorf <hwierstorf@audeering.com>, Johannes Wagner <jwagner@audeering.com>",
    "download_url": "https://files.pythonhosted.org/packages/0a/6c/deb50d275979867c9a7f39ef9faa87a7202c8b6241b8592d0b872a38cbd8/audformat-1.1.2.tar.gz",
    "platform": null,
    "description": "=========\naudformat\n=========\n\n|tests| |coverage| |docs| |python-versions| |license|\n\nSpecification and reference implementation of **audformat**.\n\naudformat stores media data,\nsuch as audio or video,\ntogether with corresponding annotations\nin a pre-defined way.\nThis makes it easy to combine or replace databases\nin machine learning projects.\n\nAn audformat database is a folder\nthat contains media files\ntogether with a header YAML file\nand one or several files storing the annotations.\nThe database is represented as an ``audformat.Database`` object\nand can be loaded with ``audformat.Database.load()``\nor written to disk with ``audformat.Database.save()``.\n\nHave a look at the installation_ and usage_ instructions\nand the `format specifications`_ as a starting point.\n\n\n.. _installation: https://audeering.github.io/audformat/install.html\n.. _usage: https://audeering.github.io/audformat/create-database.html\n.. _format specifications: https://audeering.github.io/audformat/data-introduction.html\n\n\n.. badges images and links:\n.. |tests| image:: https://github.com/audeering/audformat/workflows/Test/badge.svg\n    :target: https://github.com/audeering/audformat/actions?query=workflow%3ATest\n    :alt: Test status\n.. |coverage| image:: https://codecov.io/gh/audeering/audformat/branch/main/graph/badge.svg?token=1FEG9P5XS0\n    :target: https://codecov.io/gh/audeering/audformat/\n    :alt: code coverage\n.. |docs| image:: https://img.shields.io/pypi/v/audformat?label=docs\n    :target: https://audeering.github.io/audformat/\n    :alt: audformat's documentation\n.. |license| image:: https://img.shields.io/badge/license-MIT-green.svg\n    :target: https://github.com/audeering/audformat/blob/main/LICENSE\n    :alt: audformat's MIT license\n.. |python-versions| image:: https://img.shields.io/pypi/pyversions/audformat.svg\n    :target: https://pypi.org/project/audformat/\n    :alt: audformats's supported Python versions\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2018-present audEERING GmbH and Contributors  Authors: Johannes Wagner Hagen Wierstorf Baha Eddine Abrougui  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "Python implementation of audformat",
    "version": "1.1.2",
    "project_urls": {
        "documentation": "https://audeering.github.io/audformat/",
        "repository": "https://github.com/audeering/audformat/"
    },
    "split_keywords": [
        "audio",
        "database",
        "annotation"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fd0a5695fbb68f064996868df493c5fee3714341119cdf38d240d254c6a92dc3",
                "md5": "9d6d22899e55850d53706d6f9a077c78",
                "sha256": "bdc54ac4eb7486f6b7d6578935178b76ab47c997b5c1447fa7a7b854141acd6b"
            },
            "downloads": -1,
            "filename": "audformat-1.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9d6d22899e55850d53706d6f9a077c78",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 140922,
            "upload_time": "2024-02-02T15:22:43",
            "upload_time_iso_8601": "2024-02-02T15:22:43.362325Z",
            "url": "https://files.pythonhosted.org/packages/fd/0a/5695fbb68f064996868df493c5fee3714341119cdf38d240d254c6a92dc3/audformat-1.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0a6cdeb50d275979867c9a7f39ef9faa87a7202c8b6241b8592d0b872a38cbd8",
                "md5": "0ecd59fba95ba912a9f6267c075d6dff",
                "sha256": "a759b8ec5ef9f485095a76bf591c91d3d375fa5401304553440e5b4376d50616"
            },
            "downloads": -1,
            "filename": "audformat-1.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "0ecd59fba95ba912a9f6267c075d6dff",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 128509,
            "upload_time": "2024-02-02T15:22:44",
            "upload_time_iso_8601": "2024-02-02T15:22:44.892621Z",
            "url": "https://files.pythonhosted.org/packages/0a/6c/deb50d275979867c9a7f39ef9faa87a7202c8b6241b8592d0b872a38cbd8/audformat-1.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-02 15:22:44",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "audeering",
    "github_project": "audformat",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "audformat"
}
        
Elapsed time: 0.18016s