Follow the instructions to install the SDK. Please note that the Linux users have to manually install gstreamer.
The quality of code is insured by ruff and mypy. Please make sure to run them before pushing your code.
All the tools are available in the [dev] dependency group, so you can install them with:
uv sync --group devA good practice is to install the pre-commit hook to run ruff on the staged files before pushing. You can do it by running the following command at the root of the repository:
pre-commit installor you can run ruff manually with:
ruff check .To check the type annotations of the code, you can run mypy with the following command:
mypyPlease note that mpy results depend on the installed package. The CI runs mypy with the full installation with uv on linux. Any differences between the CI and the local environment are probably due to missing dependencies. To ensure you have the same environment as the CI, you can install the package with all the extras with uv:
uv sync --all-extras --group devThe code is tested with pytest. You can run the tests with the following command:
pytestThe CI runs a limited number of tests due to the absence of robots. Check the available options in the pyproject.toml file to run the tests that are relevant for you. For instance
pytest -m "audio"