audbcards 0.1.0__tar.gz

audbcards-0.1.0/.github/workflows/doc.yml

@@ -0,0 +1,53 @@
+name: Documentation
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ ubuntu-latest ]
+        python-version: [ '3.10' ]
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Cache .cache/audbcards
+      uses: actions/cache@v3
+      with:
+        path: ~/.cache/audbcards
+        key: audbcards-1
+
+    - name: Cache audb
+      uses: actions/cache@v3
+      with:
+        path: ~/audb
+        key: audb-1
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Ubuntu - install libsndfile
+      run: |
+        sudo apt-get update
+        sudo apt-get install --no-install-recommends --yes libsndfile1
+
+    - name: Install package
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+
+      # DOCS
+    - name: Install docs requirements
+      run: pip install -r docs/requirements.txt
+
+    - name: Test building user documentation
+      run: python -m sphinx docs/ build/html/ -b html -W

audbcards-0.1.0/.github/workflows/linter.yml

@@ -0,0 +1,29 @@
+name: Linter
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.8'
+
+    - name: Install pre-commit hooks
+      run: |
+        pip install pre-commit
+        pre-commit install --install-hooks
+
+    - name: Code style check via pre-commit
+      run: |
+        pre-commit run --all-files

audbcards-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,78 @@
+name: Publish
+
+on:
+  push:
+    tags:
+      - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      contents: write
+      id-token: write
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
+
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 2
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.10'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build virtualenv
+
+    # PyPI package
+    - name: Build Python package
+      run: python -m build
+
+    - name: Publish Python package to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+
+    # Documentation
+    - name: Install doc dependencies
+      run: |
+        pip install -r requirements.txt
+        pip install -r docs/requirements.txt
+
+    - name: Build documentation
+      run: python -m sphinx docs/ build/html -b html
+
+    - name: Deploy documentation to Github pages
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./build/html
+
+    # Github release
+    - name: Read CHANGELOG
+      id: changelog
+      run: |
+        # Get bullet points from last CHANGELOG entry
+        CHANGELOG=$(git diff -U0 HEAD^ HEAD | grep '^[+][\* ]' | sed 's/\+//')
+        echo "Got changelog: $CHANGELOG"
+        # Support for multiline, see
+        # https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#multiline-strings
+        {
+          echo 'body<<EOF'
+          echo "$CHANGELOG"
+          echo EOF
+        } >> "$GITHUB_OUTPUT"
+
+    - name: Create release on Github
+      id: create_release
+      uses: softprops/action-gh-release@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        tag_name: ${{ github.ref }}
+        name: Release ${{ github.ref_name }}
+        body: ${{ steps.changelog.outputs.body }}

audbcards-0.1.0/.github/workflows/test.yml

@@ -0,0 +1,46 @@
+name: Test
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ ubuntu-latest, macOS-latest, windows-latest ]
+        python-version: [ '3.10' ]
+        include:
+          - os: ubuntu-latest
+            python-version: '3.9'
+            tasks: tests
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Ubuntu - install libsndfile
+      run: |
+        sudo apt-get update
+        sudo apt-get install --no-install-recommends --yes libsndfile1
+      if: matrix.os == 'ubuntu-latest'
+
+    - name: Install package
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+
+    # TESTS
+    - name: Install tests requirements
+      run: pip install -r tests/requirements.txt
+
+    - name: Test with pytest
+      run: python -m pytest

audbcards-0.1.0/.gitignore

@@ -0,0 +1,11 @@
+__pycache__
+*.egg-info/
+.eggs/
+build/
+dist/
+.idea/
+venv/
+.coverage*
+__init__.pyc
+coverage.xml
+docs/api/

audbcards-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,26 @@
+# Configuration of checks run by pre-commit
+#
+# The tests are executed in the CI pipeline,
+# see CONTRIBUTING.rst for further instructions.
+# You can also run the checks directly at the terminal, e.g.
+#
+# $ pre-commit install
+# $ pre-commit run --all-files
+#
+#
+default_language_version:
+  python: python3.10
+
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.8
+    hooks:
+      - id: ruff
+        args: [ --fix ]
+      - id: ruff-format
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.4
+    hooks:
+      - id: codespell
+        additional_dependencies:
+          - tomli

audbcards-0.1.0/CHANGELOG.rst

@@ -0,0 +1,23 @@
+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.1.0 (2024-03-27)
+--------------------------
+
+* Added: initial release,
+  including the classes
+  ``audbcards.Datacard``
+  and ``audbcards.Dataset``,
+  and the ``audbcards.sphinx`` extension
+
+
+.. _Keep a Changelog:
+    https://keepachangelog.com/en/1.0.0/
+.. _Semantic Versioning:
+    https://semver.org/spec/v2.0.0.html

audbcards-0.1.0/CONTRIBUTING.rst

@@ -0,0 +1,132 @@
+Contributing
+============
+
+Everyone is invited to contribute to this project.
+Feel free to create a `pull request`_ .
+If you find errors,
+omissions,
+inconsistencies,
+or other things
+that need improvement,
+please create an issue_.
+
+.. _issue: https://github.com/audeering/audbcards/issues/new/
+.. _pull request: https://github.com/audeering/audbcards/compare/
+
+
+Development Installation
+------------------------
+
+Instead of pip-installing the latest release from PyPI_,
+you should get the newest development version from Github_::
+
+   git clone https://github.com/audeering/audbcards/
+   cd audbcards
+   # Create virtual environment for this project
+   # e.g.
+   # virtualenv --python="python3"  $HOME/.envs/audbcards
+   # source $HOME/.envs/audbcards/bin/activate
+   pip install -r requirements.txt
+
+
+This way,
+your installation always stays up-to-date,
+even if you pull new changes from the Github repository.
+
+.. _PyPI: https://pypi.org/project/audbcards/
+.. _Github: https://github.com/audeering/audbcards/
+
+
+Coding Convention
+-----------------
+
+We follow the PEP8_ convention for Python code
+and use ruff_ as a linter and code formatter.
+In addition,
+we check for common spelling errors with codespell_.
+Both tools and possible exceptions
+are defined in :file:`pyproject.toml`.
+
+The checks are executed in the CI using `pre-commit`_.
+You can enable those checks locally by executing::
+
+    pip install pre-commit  # consider system wide installation
+    pre-commit install
+    pre-commit run --all-files
+
+Afterwards ruff_ and codespell_ are executed
+every time you create a commit.
+
+You can also install ruff_ and codespell_
+and call it directly::
+
+    pip install ruff codespell  # consider system wide installation
+    ruff check --fix .  # lint all Python files, and fix any fixable errors
+    ruff format .  # format code of all Python files
+    codespell
+
+It can be restricted to specific folders::
+
+    ruff check audbcards/ tests/
+    codespell audbcards/ tests/
+
+
+.. _codespell: https://github.com/codespell-project/codespell/
+.. _PEP8: http://www.python.org/dev/peps/pep-0008/
+.. _pre-commit: https://pre-commit.com
+.. _ruff: https://beta.ruff.rs
+
+
+Building the Documentation
+--------------------------
+
+If you make changes to the documentation,
+you can re-create the HTML pages using Sphinx_.
+You can install it and a few other necessary packages with::
+
+    pip install -r docs/requirements.txt
+
+To create the HTML pages, use::
+
+    python -m sphinx docs/ build/sphinx/html -b html
+
+To ensure that anonymous access is used
+when communicating with Artifactory,
+you can call instead::
+
+    ARTIFACTORY_USERNAME=anonymous ARTIFACTORY_API_KEY="" python -m sphinx docs/ build/sphinx/html -b html
+
+The generated files will be available
+in the directory :file:`build/sphinx/html/`.
+
+It is also possible to automatically check if all links are still valid::
+
+    python -m sphinx docs/ build/sphinx/html -b linkcheck
+
+.. _Sphinx: http://sphinx-doc.org
+
+
+Running the Tests
+-----------------
+
+You'll need pytest_ for that.
+It can be installed with::
+
+    pip install -r tests/requirements.txt
+
+To execute the tests, simply run::
+
+    python -m pytest
+
+.. _pytest: https://pytest.org
+
+
+Creating a New Release
+----------------------
+
+New releases are made using the following steps:
+
+#. Update ``CHANGELOG.rst``
+#. Commit those changes as "Release X.Y.Z"
+#. Create an (annotated) tag with ``git tag -a X.Y.Z``
+#. Push the commit and the tag to Github

audbcards-0.1.0/LICENSE

@@ -0,0 +1,25 @@
+MIT License
+
+Copyright (c) 2023- audEERING GmbH and Contributors
+
+Authors:
+    Hagen Wierstorf
+    Christian Geng
+
+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.

audbcards-0.1.0/PKG-INFO

@@ -0,0 +1,63 @@
+Metadata-Version: 2.1
+Name: audbcards
+Version: 0.1.0
+Summary: Create data cards for audb databases
+Author: BahaEddine Abrougui
+Author-email: Hagen Wierstorf <hwierstorf@audeering.com>, Christian Geng <cgeng@audeering.com>
+License: MIT License
+        
+        Copyright (c) 2023- audEERING GmbH and Contributors
+        
+        Authors:
+            Hagen Wierstorf
+            Christian Geng
+        
+        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.
+        
+Project-URL: repository, https://github.com/audeering/audbcards/
+Project-URL: documentation, https://audeering.github.io/audbcards/
+Keywords: audio,data,annotation,mlops,machine learning,documentation
+Classifier: Development Status :: 4 - Beta
+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.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.9
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: audb>=1.6.0
+Requires-Dist: audbackend>=1.0.1
+Requires-Dist: audplot>=1.4.6
+Requires-Dist: jinja2
+Requires-Dist: pandas>=2.1.0
+Requires-Dist: toml
+
+=========
+audbcards
+=========
+
+**audbcards** creates data cards for audio datasets
+handled by audb_.
+
+.. _audb: https://audeering.github.io/audb/

audbcards-0.1.0/README.rst

@@ -0,0 +1,8 @@
+=========
+audbcards
+=========
+
+**audbcards** creates data cards for audio datasets
+handled by audb_.
+
+.. _audb: https://audeering.github.io/audb/

audbcards-0.1.0/audbcards/__init__.py

@@ -0,0 +1,16 @@
+from audbcards.core.datacard import Datacard
+from audbcards.core.dataset import Dataset
+
+
+__all__ = []
+
+
+# Dynamically get the version of the installed module
+try:
+    import importlib.metadata
+
+    __version__ = importlib.metadata.version(__name__)
+except Exception:  # pragma: no cover
+    importlib = None  # pragma: no cover
+finally:
+    del importlib