python/README

   1 Python aubio module
   2 ===================
   3
   4 This module wraps the aubio library for Python using the numpy module.
   5
   6 Before compiling this module, you must have compiled libaubio.
   7
   8 For more information about how this module works, please refer to the [Python/C
   9 API Reference Manual] (http://docs.python.org/c-api/index.html) and the
  10 [Numpy/C API Reference](http://docs.scipy.org/doc/numpy/reference/c-api.html).
  11
  12 Compiling python aubio
  13 ----------------------
  14
  15 After libaubio has been build successfully, and provided Python development
  16 headers and numpy can be found on your system, you should be able to build the
  17 aubio Python module:
  18
  19     $ ./setup.py build
  20
  21 To find out more about `setup.py` options:
  22
  23     $ ./setup.py --help
  24
  25 Installing
  26 ----------
  27
  28 To install the Python module:
  29
  30     $ ./setup.py install
  31
  32 Using the Python module
  33 -----------------------
  34
  35 Once the aubio library and the Python module are installed, you will be able to
  36 import the aubio module:
  37
  38     $ python
  39     [...]
  40     >>> import aubio
  41     >>>
  42
  43 Alternatively, you may want to use the Python module without installing it by
  44 setting PYTHONPATH:
  45
  46     $ export PYTHONPATH=$PYTHONPATH:$PWD/`ls -rtd build/lib.* | head -1`:$PWD/tests
  47
  48 Testing the Python module
  49 -------------------------
  50
  51 Once both the C library and the Python module have been built correctly, and
  52 after you have installed them (or setting the environment variable correctly),
  53 you should be able to run the tests:
  54
  55     $ ./tests/run_all_tests
  56
  57 And to try out the demos:
  58
  59     $ ./demos/demo_source.wav /path/to/sound/sample.wav
  60
  61 You need to install additional modules to run some of the demos. For
  62 instance, several demos use [matplotlib](http://matplotlib.org/) to draw plots.
  63 Some more demos use [PySoundCard](https://github.com/bastibe/PySoundCard) to
  64 play and record sounds.