Skip to content

Commit

Permalink
adds instructions on compiling the wheels to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Bastian Bechtold committed Feb 10, 2023
1 parent aa5ea86 commit 07ae8fd
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Installation
------------

The ``soundfile`` module depends on the Python packages CFFI and NumPy, and the
system library libsndfile.
library libsndfile.

In a modern Python, you can use ``pip install soundfile`` to download
and install the latest release of the ``soundfile`` module and its
Expand All @@ -79,6 +79,24 @@ Binaries for Python Extension Packages <http://www.lfd.uci.edu/~gohlke/pythonlib

.. _Anaconda: https://www.continuum.io/downloads

Building
--------

``Soundfile`` itself does not contain any compiled code and can be
bundled into a wheel with the usual ``python setup.py bdist_wheel``.
However, ``soundfile`` relies on libsndfile, and optionally ships its
own copy of libsndfile in the wheel.

To build a binary wheel that contains libsndfile, make sure to
checkout and update the ``_soundfile_data`` submodule, then run
``python setup.py bdist_wheel`` as usual. If the resulting file size
of the wheel is around one megabyte, a matching libsndfile has been
bundled (without libsndfile, it's around 25 KB).

To build binary wheels for all supported platforms, run ``python
build_wheels.py``, which will ``python setup.py bdist_wheel`` for each
of the platforms we have precompiled libsndfiles for.

Error Reporting
---------------

Expand Down

0 comments on commit 07ae8fd

Please sign in to comment.