Skip to content

Installation instructions #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bastibe merged 2 commits into from
Apr 12, 2015
Merged

Installation instructions #47

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6a5c64d
updated installation instructions for wheels
bastibe Apr 10, 2015
88916e5
improved wording
bastibe Apr 12, 2015
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
40 changes: 14 additions & 26 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ PySoundFile
===========

`PySoundFile <https://github.com/bastibe/PySoundFile>`__ is an audio
library based on libsndfile, CFFI and Numpy. Full documentation is
library based on libsndfile, CFFI and NumPy. Full documentation is
available on http://pysoundfile.readthedocs.org/.

PySoundFile can read and write sound files. File reading/writing is
Expand Down Expand Up @@ -39,34 +39,22 @@ might be removed in the future.
Installation
------------

PySoundFile depends on the Python packages CFFI and Numpy, and the
PySoundFile depends on the Python packages CFFI and NumPy, and the
system library libsndfile.

To install the Python dependencies, I recommend using the `Anaconda
<http://continuum.io/downloads#34>`__ Distribution of Python. Anaconda
provides the ``conda`` package manager, which will install all
dependencies using ``conda install cffi numpy`` (conda is also
independently available on pip).

You will also need to install `libsndfile
<http://www.mega-nerd.com/libsndfile/>`__. On Windows, libsndfile is
included in the binary installers (see below). On OS X, `homebrew
<http://www.mega-nerd.com/libsndfile/>`__ can install libsndfile using
``brew install libsndfile``. On Linux, use your distribution's package
manager, for example ``sudo apt-get install libsndfile``.

With CFFI, Numpy, and libsndfile installed, you can use `pip
<http://pip.readthedocs.org/en/latest/installing.html>`__ to install
`PySoundFile <https://pypi.python.org/pypi/PySoundFile/0.6.0>`__ with
``pip install pysoundfile`` or ``pip install pysoundfile --user`` if you
don't have administrator privileges. If you are running Windows you
should download the Windows installers for PySoundFile instead (which
also include libsndfile):

| `PySoundFile-0.6.0.win-amd64-py2.7 <https://github.com/bastibe/PySoundFile/releases/download/0.6.0/PySoundFile-0.6.0.win-amd64-py2.7.exe>`__
| `PySoundFile-0.6.0.win-amd64-py3.4 <https://github.com/bastibe/PySoundFile/releases/download/0.6.0/PySoundFile-0.6.0.win-amd64-py3.4.exe>`__
| `PySoundFile-0.6.0.win32-py2.7 <https://github.com/bastibe/PySoundFile/releases/download/0.6.0/PySoundFile-0.6.0.win32-py2.7.exe>`__
| `PySoundFile-0.6.0.win32-py3.4 <https://github.com/bastibe/PySoundFile/releases/download/0.6.0/PySoundFile-0.6.0.win32-py3.4.exe>`__
<http://continuum.io/downloads>`__ distribution of Python 3. This will
come with all dependencies pre-installed. To install the dependencies
manually, you can use the ``conda`` package manager, which will
install all dependencies using ``conda install cffi numpy`` (conda is
also available independently of Anaconda with ``pip install conda;
conda init``).

With CFFI and NumPy installed, you can use ``pip install pysoundfile``
to download and install the latest release of PySoundFile. On Windows
and OS X, this will also install the library libsndfile. On Linux, you
need to install libsndfile using your distribution's package manager,
for example ``sudo apt-get install libsndfile1``.

Read/Write Functions
--------------------
Expand Down