source: doc/python_module.rst @ f651625

sampler
Last change on this file since f651625 was d8380d2, checked in by Paul Brossier <piem@piem.org>, 8 years ago

doc/python_module.rst: add print(aubio.version)
  • Property mode set to 100644
File size: 1.7 KB

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:

$ pip install aubio

Building the module

From aubio source directory, run the following:

$ ./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; print(aubio.version)".

A simple example

Here is a :download:`simple script <../python/demos/demo_source_simple.py>` that reads all the samples from a media file:

??
.. literalinclude:: ../python/demos/demo_source_simple.py
   :language: python

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 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.

Note: See TracBrowser for help on using the repository browser.