audeer


Nameaudeer JSON
Version 2.2.0 PyPI version JSON
download
home_pageNone
SummaryHelpful Python functions
upload_time2024-07-23 08:53:32
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseMIT License Copyright (c) 2018-present audEERING GmbH and Contributors Authors: Johannes Wagner Hagen Wierstorf 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 python tools
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ======
audeer
======

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

The Python package **audeer** collects small tools and functions
that deal with common tasks.
For example, it incorporates functions for handling file paths,
using multi-threading, or showing progress bars.

The package is lightweight,
and has the small tqdm_ package
as it's only external dependency.

Have a look at the installation_ and usage_ instructions as a starting point.

Code example,
that lists all WAV files in the ``data`` folder:

.. code-block:: python

    import audeer

    files = audeer.list_file_names("data", filetype="wav")


.. _tqdm: https://tqdm.github.io/
.. _installation: https://audeering.github.io/audeer/installation.html
.. _usage: https://audeering.github.io/audeer/usage.html

.. badges images and links:
.. |tests| image:: https://github.com/audeering/audeer/workflows/Test/badge.svg
    :target: https://github.com/audeering/audeer/actions?query=workflow%3ATest
    :alt: Test status
.. |coverage| image:: https://codecov.io/gh/audeering/audeer/branch/main/graph/badge.svg?token=PUA9P2UJW1
    :target: https://codecov.io/gh/audeering/audeer
    :alt: code coverage
.. |docs| image:: https://img.shields.io/pypi/v/audeer?label=docs
    :target: https://audeering.github.io/audeer/
    :alt: audeer's documentation
.. |license| image:: https://img.shields.io/badge/license-MIT-green.svg
    :target: https://github.com/audeering/audeer/blob/main/LICENSE
    :alt: audeer's MIT license
.. |python-versions| image:: https://img.shields.io/pypi/pyversions/audeer.svg
    :target: https://pypi.org/project/audeer/
    :alt: audeer's supported Python versions

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "audeer",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "Python, tools",
    "author": null,
    "author_email": "Hagen Wierstorf <hwierstorf@audeering.com>, Johannes Wagner <jwagner@audeering.com>",
    "download_url": "https://files.pythonhosted.org/packages/14/8a/3d6486704c8fe7c8f888a9c13fcb46121cfd130c346f1bc3a7fbff49a029/audeer-2.2.0.tar.gz",
    "platform": null,
    "description": "======\naudeer\n======\n\n|tests| |coverage| |docs| |python-versions| |license| \n\nThe Python package **audeer** collects small tools and functions\nthat deal with common tasks.\nFor example, it incorporates functions for handling file paths,\nusing multi-threading, or showing progress bars.\n\nThe package is lightweight,\nand has the small tqdm_ package\nas it's only external dependency.\n\nHave a look at the installation_ and usage_ instructions as a starting point.\n\nCode example,\nthat lists all WAV files in the ``data`` folder:\n\n.. code-block:: python\n\n    import audeer\n\n    files = audeer.list_file_names(\"data\", filetype=\"wav\")\n\n\n.. _tqdm: https://tqdm.github.io/\n.. _installation: https://audeering.github.io/audeer/installation.html\n.. _usage: https://audeering.github.io/audeer/usage.html\n\n.. badges images and links:\n.. |tests| image:: https://github.com/audeering/audeer/workflows/Test/badge.svg\n    :target: https://github.com/audeering/audeer/actions?query=workflow%3ATest\n    :alt: Test status\n.. |coverage| image:: https://codecov.io/gh/audeering/audeer/branch/main/graph/badge.svg?token=PUA9P2UJW1\n    :target: https://codecov.io/gh/audeering/audeer\n    :alt: code coverage\n.. |docs| image:: https://img.shields.io/pypi/v/audeer?label=docs\n \u00a0 \u00a0:target: https://audeering.github.io/audeer/\n \u00a0 \u00a0:alt: audeer's documentation\n.. |license| image:: https://img.shields.io/badge/license-MIT-green.svg\n \u00a0 \u00a0:target: https://github.com/audeering/audeer/blob/main/LICENSE\n \u00a0 \u00a0:alt: audeer's MIT license\n.. |python-versions| image:: https://img.shields.io/pypi/pyversions/audeer.svg\n    :target: https://pypi.org/project/audeer/\n    :alt: audeer's supported Python versions\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2018-present audEERING GmbH and Contributors  Authors: Johannes Wagner Hagen Wierstorf  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": "Helpful Python functions",
    "version": "2.2.0",
    "project_urls": {
        "documentation": "https://audeering.github.io/audeer/",
        "repository": "https://github.com/audeering/audeer/"
    },
    "split_keywords": [
        "python",
        " tools"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d316137d34017ef2b6b2907ef4da31fca8bdcc20ae1b262455fb07f77ee8efcc",
                "md5": "75f78efc73a35c01db1db500a456f13c",
                "sha256": "47452456288e812e43cd42bdd55a51c21a60190a0c4850130ec3883761187194"
            },
            "downloads": -1,
            "filename": "audeer-2.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "75f78efc73a35c01db1db500a456f13c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 41190,
            "upload_time": "2024-07-23T08:53:30",
            "upload_time_iso_8601": "2024-07-23T08:53:30.848465Z",
            "url": "https://files.pythonhosted.org/packages/d3/16/137d34017ef2b6b2907ef4da31fca8bdcc20ae1b262455fb07f77ee8efcc/audeer-2.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "148a3d6486704c8fe7c8f888a9c13fcb46121cfd130c346f1bc3a7fbff49a029",
                "md5": "f842e8a8c8a901279e3c248cf63f39a8",
                "sha256": "e5774ba24b4d69a14f27d3a82aec796c8ef18e299759a050a8c9b9e92433b71e"
            },
            "downloads": -1,
            "filename": "audeer-2.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "f842e8a8c8a901279e3c248cf63f39a8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 44175,
            "upload_time": "2024-07-23T08:53:32",
            "upload_time_iso_8601": "2024-07-23T08:53:32.393999Z",
            "url": "https://files.pythonhosted.org/packages/14/8a/3d6486704c8fe7c8f888a9c13fcb46121cfd130c346f1bc3a7fbff49a029/audeer-2.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-23 08:53:32",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "audeering",
    "github_project": "audeer",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "audeer"
}
        
Elapsed time: 0.55939s