Skip to content

Latest commit

 

History

History
39 lines (24 loc) · 1.01 KB

File metadata and controls

39 lines (24 loc) · 1.01 KB

Contributing

If you find any bugs or other things that need improvement, please create an issue or a pull request at https://github.com/joextodd/pysoundio/. Contributions are always welcome!

You should get the latest version from GitHub:

git clone https://github.com/joextodd/pysoundio.git
cd pysoundio

To install the package for development, first build the library

python3 pysoundio/builder/soundio.py

and then install with pip.

pip3 install .

Before submitting a pull request, make sure all tests are passing, and all of the example scripts run as they as should.

If you make changes to the documentation, you can locally re-create the HTML pages using Sphinx. You can install it and the read the docs theme with:

pip3 install -r docs/requirements.txt

To create the HTML pages, use:

python3 setup.py build_sphinx

The generated files will be available in the directory docs/_build/html.