Changeset 5417b3a

Timestamp:

Aug 26, 2016, 3:39:52 PM (8 years ago)

Author:

Paul Brossier <piem@piem.org>

Branches:

feature/autosink, feature/cnn, feature/cnn_org, feature/constantq, feature/crepe, feature/crepe_org, feature/pitchshift, feature/pydocstrings, feature/timestretch, fix/ffmpeg5, master, pitchshift, sampler, timestretch, yinfft+

Children:

88f7cf9

Parents:

f7547e7

Message:

doc/python_module.rst: improve

File:

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

doc/python_module.rst

@@ -1 @@
-aubio Python module
-===================
+Python module
+=============
 
-Installing with pip
--------------------
+Installing aubio with pip
+-------------------------
 
 .. code-block:: bash
@@ -20 +20 @@
     $ 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"``.
+
+A very simple example
+.....................
+
+Here is a very simple script
+to read all the samples from a media file:
 
 .. code-block:: python
@@ -33 +40 @@
         while True:
           samples, read = s()
-          print samples
+          #print(samples)
           if read < 256: break
 
-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, `demo_filter.py`_. This files executes the following:
+
+* read an input media file (``aubio.source``)
+
+* filter it using an 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 tests folder: https://github.com/aubio/aubio/blob/master/python/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
+