doc/python_module.rst

   1 .. _python:
   2
   3 Python module
   4 =============
   5
   6 The aubio extension for Python is available for Python 2.7 and Python 3.
   7
   8 Installing aubio with pip
   9 -------------------------
  10
  11 aubio can now be installed using ``pip`` and ``easy_install``.
  12
  13 .. code-block:: bash
  14
  15     $ pip install aubio
  16
  17 Building the module
  18 -------------------
  19
  20 From ``aubio`` source directory, run the following:
  21
  22 .. code-block:: bash
  23
  24     $ ./setup.py clean
  25     $ ./setup.py build
  26     $ sudo ./setup.py install
  27
  28 Using aubio in python
  29 ---------------------
  30
  31 Once you have python-aubio installed, you should be able to run ``python -c
  32 "import aubio"``.
  33
  34 A simple example
  35 ................
  36
  37 Here is a :download:`simple script <../python/demos/demo_source_simple.py>`
  38 that reads all the samples from a media file:
  39
  40 .. literalinclude:: ../python/demos/demo_source_simple.py
  41    :language: python
  42
  43 Filtering an input sound file
  44 .............................
  45
  46 Here is a more complete example, :download:`demo_filter.py
  47 <../python/demos/demo_filter.py>`. This files executes the following:
  48
  49 * read an input media file (``aubio.source``)
  50
  51 * filter it using an `A-weighting <https://en.wikipedia.org/wiki/A-weighting>`_
  52   filter (``aubio.digital_filter``)
  53
  54 * write result to a new file (``aubio.sink``)
  55
  56 .. literalinclude:: ../python/demos/demo_filter.py
  57    :language: python
  58
  59 More demos
  60 ..........
  61
  62 Check out the `python demos folder`_ for more examples.
  63
  64 Python tests
  65 ------------
  66
  67 A number of `python tests`_ are provided. To run them, use
  68 ``python/tests/run_all_tests``.
  69
  70 .. _python demos folder: https://github.com/aubio/aubio/blob/master/python/demos
  71 .. _demo_filter.py: https://github.com/aubio/aubio/blob/master/python/demos/demo_filter.py
  72 .. _python tests: https://github.com/aubio/aubio/blob/master/python/tests
  73