Changes in doc/python_module.rst [34abeaf:d8380d2]

File:

• doc/python_module.rst (modified) (2 diffs)

doc/python_module.rst

@@ -1 @@
-aubio Python module
-===================
+.. _python:
+
+Python module
+=============
+
+The aubio extension for Python is available for Python 2.7 and Python 3.
+
+Installing aubio with pip
+-------------------------
+
+aubio can now be installed using ``pip``:
+
+.. code-block:: bash
+
+    $ pip install aubio
 
 Building the module
@@ -9 +22 @@
 .. code-block:: bash
 
-    $ cd python
+    $ ./setup.py clean
     $ ./setup.py build
     $ sudo ./setup.py install
 
-Using the module
-----------------
+Using aubio in python
+---------------------
 
-To use the python module, simply import aubio:
+Once you have python-aubio installed, you should be able to run ``python -c
+"import aubio; print(aubio.version)"``.
 
-.. code-block:: python
+A simple example
+................
 
-        #! /usr/bin/env python
-        import aubio
+Here is a :download:`simple script <../python/demos/demo_source_simple.py>`
+that reads all the samples from a media file:
 
-        s = aubio.source(sys.argv[1], 0, 256)
-        while True:
-          samples, read = s()
-          print samples
-          if read < 256: break
+.. literalinclude:: ../python/demos/demo_source_simple.py
+   :language: python
 
-Check out the `python demos for aubio
-<https://github.com/piem/aubio/blob/develop/python/demos/>`_ for more examples.
+Filtering an input sound file
+.............................
 
+Here is a more complete example, :download:`demo_filter.py
+<../python/demos/demo_filter.py>`. This files executes the following:
+
+* read an input media file (``aubio.source``)
+
+* filter it using an `A-weighting <https://en.wikipedia.org/wiki/A-weighting>`_
+  filter (``aubio.digital_filter``)
+
+* write result to a new file (``aubio.sink``)
+
+.. literalinclude:: ../python/demos/demo_filter.py
+   :language: python
+
+More demos
+..........
+
+Check out the `python demos folder`_ for more examples.
+
+Python tests
+------------
+
+A number of `python tests`_ are provided. To run them, use
+``python/tests/run_all_tests``.
+
+.. _python demos folder: https://github.com/aubio/aubio/blob/master/python/demos
+.. _demo_filter.py: https://github.com/aubio/aubio/blob/master/python/demos/demo_filter.py
+.. _python tests: https://github.com/aubio/aubio/blob/master/python/tests
+