If you find bugs, errors, omissions or other things that need improvement, please create an issue or a pull request at https://github.com/bastibe/python-soundfile/. Contributions are always welcome!
If you fix a bug, you should add a test that exposes the bug (to avoid future regressions), if you add a feature, you should add tests for it as well.
To run the tests, use:
python setup.py test
This uses py.test; if you haven't installed it already, it will be downloaded and installed for you.
Note
There is a known problem that prohibits the use of file descriptors on Windows if the libsndfile DLL was compiled with a different compiler than the Python interpreter. Unfortunately, this is typically the case if the packaged DLLs are used. To skip the tests which utilize file descriptors, use:
python setup.py test --pytest-args="-knot\ fd"
If you want to measure code coverage, you can use coverage.py. Just install it with:
pip install coverage --user
... and run it with:
coverage run --source soundfile.py -m py.test coverage html
The resulting HTML files will be written to the htmlcov/ directory.
You can even check branch coverage:
coverage run --branch --source soundfile.py -m py.test coverage html
If you make changes to the documentation, you can re-create the HTML pages on your local system using Sphinx.
You can install it and a few other necessary packages with:
pip install -r doc/requirements.txt --user
To create the HTML pages, use:
python setup.py build_sphinx
The generated files will be available in the directory build/sphinx/html/.