[doc] move api references to doc, simplify pip instructions, add conda section
authorPaul Brossier <piem@piem.org>
Wed, 21 Nov 2018 18:28:07 +0000 (19:28 +0100)
committerPaul Brossier <piem@piem.org>
Wed, 21 Nov 2018 18:28:07 +0000 (19:28 +0100)
doc/python_module.rst
python/README.md

index 4e3ec58..48e5e54 100644 (file)
@@ -3,28 +3,50 @@
 Installing aubio for Python
 ===========================
 
-The aubio extension for Python is available for Python 2.7 and Python 3.
+aubio is available as a package for Python 2.7 and Python 3. The aubio
+extension is written C using the `Python/C`_ and the `Numpy/C`_ APIs.
+
+.. _Python/C: https://docs.python.org/c-api/index.html
+.. _Numpy/C: https://docs.scipy.org/doc/numpy/reference/c-api.html
+
+For general documentation on how to install Python packages, see `Installing
+Packages`_.
 
 Installing aubio with pip
 -------------------------
 
-aubio can now be installed using ``pip``:
+aubio can be installed from `PyPI`_ using ``pip``:
 
 .. code-block:: console
 
     $ pip install aubio
 
-Building the module
--------------------
+See also `Installing from PyPI`_ for general documentation.
+
+.. note::
+
+  aubio is currently a `source only`_ package, so you will need a compiler to
+  install it from `PyPI`_. See also `Installing aubio with conda`_ for
+  pre-compiled binaries.
 
-From ``aubio`` source directory, run the following:
+.. _PyPI: https://pypi.python.org/pypi/aubio
+.. _Installing Packages: https://packaging.python.org/tutorials/installing-packages/
+.. _Installing from PyPI: https://packaging.python.org/tutorials/installing-packages/#installing-from-pypi
+.. _source only: https://packaging.python.org/tutorials/installing-packages/#source-distributions-vs-wheels
+
+Installing aubio with conda
+---------------------------
+
+`Conda packages`_ are available through the `conda-forge`_ channel for Linux,
+macOS, and Windows:
 
 .. code-block:: console
 
-    $ ./setup.py clean
-    $ ./setup.py build
-    $ sudo ./setup.py install
+    $ conda config --add channels conda-forge
+    $ conda install -c conda-forge aubio
 
+.. _Conda packages: https://anaconda.org/conda-forge/aubio
+.. _conda-forge: https://conda-forge.org/
 
 .. _py-doubleprecision:
 
index 998f9cd..f192ab4 100644 (file)
@@ -75,7 +75,3 @@ Note: you might need to install additional modules to run some of the demos.
 Some demos use [matplotlib](http://matplotlib.org/) to draw plots, others use
 [PySoundCard](https://github.com/bastibe/PySoundCard) to play and record
 sounds.
-
-For more information about how this module works, please refer to the [Python/C
-API Reference Manual] (http://docs.python.org/c-api/index.html) and the
-[Numpy/C API Reference](http://docs.scipy.org/doc/numpy/reference/c-api.html).