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
14 changes: 6 additions & 8 deletions .github/workflows/doc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,14 @@ jobs:
with:
python-version: ${{ matrix.python-version }}

- name: Install package
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
- name: Set up uv
uses: astral-sh/setup-uv@v5

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

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

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

- name: Set up uv
uses: astral-sh/setup-uv@v5

- name: Install pre-commit hooks
run: |
pip install pre-commit
pre-commit install --install-hooks
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
28 changes: 13 additions & 15 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,18 +34,19 @@ jobs:
with:
python-version: '3.10'

- name: Set up uv
uses: astral-sh/setup-uv@v4

- name: Install build dependencies
run: |
python -m pip install --upgrade pip
pip install build virtualenv
run: uv sync

- name: Build wheels
run: python -m build --wheel --outdir wheelhouse
run: uv build --wheel --out-dir wheelhouse
env:
PLAT_NAME: ${{ matrix.platform }}

- name: Build source distribution
run: python -m build --sdist --outdir wheelhouse
run: uv build --sdist --out-dir wheelhouse
if: matrix.platform == 'manylinux_2_17_x86_64'

- uses: actions/upload-artifact@v4
Expand Down Expand Up @@ -82,14 +83,15 @@ jobs:
with:
python-version: '3.10'

- name: Set up uv
uses: astral-sh/setup-uv@v5

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install build virtualenv
run: uv sync

# 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 @@ -103,14 +105,10 @@ jobs:
sudo apt-get -y install libsndfile1 sox

- name: Install doc dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
pip install -r docs/requirements.txt
run: uv sync

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

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

- name: Set up uv
uses: astral-sh/setup-uv@v5

- name: Setup Ubuntu
run: |
sudo apt-get update
sudo apt-get -y install libsndfile1 sox
if: matrix.os == 'ubuntu-latest'

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
pip install -r tests/requirements.txt
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
38 changes: 13 additions & 25 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,8 @@ you should get the newest development version from Github_::

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


This way,
Expand All @@ -46,25 +43,22 @@ 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::
You can also call ruff_ and codespell_ 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 opensmile/ tests/
codespell opensmile/ tests/
$ uvx ruff check opensmile/ tests/
$ uvx codespell opensmile/ tests/


.. _codespell: https://github.com/codespell-project/codespell/
Expand All @@ -78,20 +72,17 @@ 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
$ uv run --python 3.12 sphinx-build 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
$ uv run --python 3.12 sphinx-build docs/ build/sphinx/html -b linkcheck

.. _Sphinx: http://sphinx-doc.org

Expand All @@ -100,13 +91,10 @@ 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
$ uv run pytest

.. _pytest: https://pytest.org

Expand Down
8 changes: 0 additions & 8 deletions docs/requirements.txt

This file was deleted.

19 changes: 19 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,25 @@ repository = 'https://github.com/audeering/opensmile-python/'
documentation = 'https://audeering.github.io/opensmile-python/'


# ===== DEPENDENCY GROUPS =================================================
[dependency-groups]
dev = [
# Tests
'pytest',
'pytest-doctestplus',
'pytest-cov',
# Docs
'audb',
'ipykernel',
'jupyter-sphinx',
'sphinx',
'sphinx-audeering-theme >=1.2.1',
'sphinx-autodoc-typehints',
'sphinx-copybutton',
'toml',
]


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

This file was deleted.

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

This file was deleted.

Loading