Skip to content
Merged
Show file tree
Hide file tree
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
18 changes: 7 additions & 11 deletions .github/workflows/doc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,21 +29,17 @@ jobs:
with:
python-version: ${{ matrix.python-version }}

- name: Ubuntu - install libsndfile1
run: |
sudo apt-get update
sudo apt-get install --no-install-recommends --yes libsndfile1
- name: Install uv
uses: astral-sh/setup-uv@v5

- name: Install package
- name: Ubuntu - install libsndfile1 and portaudio
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
sudo apt-get update
sudo apt-get install --no-install-recommends --yes libsndfile1 portaudio19-dev

- name: Install docs requirements
run: pip install -r docs/requirements.txt

- name: Test building documentation
run: python -m sphinx docs/ docs/_build/ -b html -W
run: uv run python -m sphinx docs/ docs/_build/ -b html -W

- name: Check links in documentation
run: python -m sphinx docs/ docs/_build/ -b linkcheck -W
run: uv run python -m sphinx docs/ docs/_build/ -b linkcheck -W
10 changes: 5 additions & 5 deletions .github/workflows/linter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ jobs:
with:
python-version: '3.10'

- name: Install uv
uses: astral-sh/setup-uv@v5

- name: Install pre-commit hooks
run: |
pip install pre-commit
pre-commit install --install-hooks
run: uvx pre-commit install --install-hooks

- name: Code style check via pre-commit
run: |
pre-commit run --all-files
run: uvx pre-commit run --all-files
14 changes: 5 additions & 9 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,13 @@ jobs:
with:
python-version: '3.10'

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install build virtualenv
- name: Install uv
uses: astral-sh/setup-uv@v5


# PyPI package
- name: Build Python package
run: python -m build
run: uv build

- name: Publish Python package to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
Expand All @@ -42,12 +41,9 @@ jobs:
run: |
sudo apt-get update
sudo apt-get install --no-install-recommends --yes libsndfile1 sox
pip install -r requirements.txt
pip install -r docs/requirements.txt

- name: Build documentation
run: |
python -m sphinx docs/ docs/_build/ -b html
run: uv run python -m sphinx docs/ docs/_build/ -b html

- name: Deploy documentation to Github pages
uses: peaceiris/actions-gh-pages@v4
Expand Down
14 changes: 6 additions & 8 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ jobs:
with:
python-version: ${{ matrix.python-version }}

- name: Install uv
uses: astral-sh/setup-uv@v5

- name: Prepare Macos
run: |
brew install portaudio
Expand All @@ -40,16 +43,11 @@ jobs:
sudo apt-get install --no-install-recommends --yes libsndfile1 sox portaudio19-dev
if: matrix.os == 'ubuntu-latest'

- name: Install dependencies
run: |
python -V
python -m pip install --upgrade pip
pip install -r requirements.txt
pip install -r tests/requirements.txt
- name: Sync Python environment
run: uv sync

- name: Test with pytest
run: |
python -m pytest
run: uv run pytest

- name: Upload coverage to Codecov
uses: codecov/codecov-action@v4
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ venv/
.coverage
coverage.xml
docs/api/
uv.lock
44 changes: 14 additions & 30 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,7 @@ you should get the newest development version from Github_::

git clone https://github.com/audeering/audinterface/
cd audinterface
# Create virtual environment for this project
# e.g.
# virtualenv --python="python3" $HOME/.envs/audinterface
# source $HOME/.envs/audinterface/bin/activate
pip install -r requirements.txt
uv sync


This way,
Expand All @@ -50,25 +46,23 @@ 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
uvx pre-commit install
uvx 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
uvx ruff check --fix . # lint all Python files, and fix any fixable errors
uvx ruff format . # format code of all Python files
uvx codespell

It can be restricted to specific folders::

ruff check audformat/ tests/
codespell audformat/ tests/
uvx ruff check audinterface/ tests/
uvx codespell audinterface/ tests/


.. _codespell: https://github.com/codespell-project/codespell/
Expand All @@ -81,36 +75,26 @@ 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::
you can re-create the HTML pages using Sphinx_::

pip install -r docs/requirements.txt

To create the HTML pages, use::

python -m sphinx docs/ build/sphinx/html -b html
uv run python -m sphinx docs/ build/html -b html

The generated files will be available
in the directory :file:`build/sphinx/html/`.
in the directory :file:`build/html/`.

It is also possible to automatically check if all links are still valid::

python -m sphinx docs/ build/sphinx/html -b linkcheck
uv run python -m sphinx docs/ build/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::
You can run tests with pytest_::

python -m pytest
uv run pytest

.. _pytest: https://pytest.org

Expand Down
9 changes: 6 additions & 3 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@ To install :mod:`audinterface` run:

.. code-block:: bash

$ # Create and activate Python virtual environment, e.g.
$ # virtualenv --no-download --python=python3 ${HOME}/.envs/audinterface
$ # source ${HOME}/.envs/audinterface/bin/activate
$ pip install audinterface

To interactively test it run:

.. code-block:: bash

$ uvx --with audinterface ipython
8 changes: 0 additions & 8 deletions docs/requirements.txt

This file was deleted.

24 changes: 24 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,30 @@ repository = 'https://github.com/audeering/audinterface/'
documentation = 'https://audeering.github.io/audinterface/'


# ===== Dependency groups =================================================
[dependency-groups]
dev = [
'audb >=1.11.0',
'audeer >=1.21.0',
'auditok >=0.3.0',
'audobject >=0.7.5',
'faster-whisper', # for usage example with ASR
'librosa >=0.11.0',
'onnxruntime ==1.19.2 ; python_version == "3.9"',
'onnxruntime ; python_version >= "3.10"',
'pytest',
'pytest-cov',
'soxr >=0.4.0b1', # for numpy 2
'sphinx',
'sphinx-apipages >=0.1.2',
'sphinx-audeering-theme >=1.2.1',
'sphinx-autodoc-typehints',
'sphinx-copybutton',
'sybil',
'toml',
]


# ===== BUILD-SYSTEM ======================================================
#
# Requirements for building the Python package
Expand Down
1 change: 0 additions & 1 deletion requirements.txt

This file was deleted.

10 changes: 0 additions & 10 deletions tests/requirements.txt

This file was deleted.

Loading