Python module
=============

Installing aubio with pip
-------------------------

.. code-block:: bash

    $ pip install aubio

Building the module
-------------------

From ``aubio`` source directory, run the following:

.. code-block:: bash

    $ ./setup.py clean
    $ ./setup.py build
    $ sudo ./setup.py install

Using aubio in python
---------------------

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

        #! /usr/bin/env python
        import aubio

        s = aubio.source(sys.argv[1], 0, 256)
        while True:
          samples, read = s()
          #print(samples)
          if read < 256: break

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