python/README.md

   1 Python aubio module
   2 ===================
   3
   4 This module wraps the aubio library for Python using the numpy module.
   5
   6 Finding some inspiration
   7 ------------------------
   8
   9 Some examples are available in the `python/demos` directory. These scripts are
  10 small programs written in python and using python-aubio.
  11
  12 For instance, `demo_source.py` reads a media file.
  13
  14     $ ./python/demos/demo_source.py /path/to/sound/sample.wav
  15
  16 and `demo_timestretch_online.py` stretches the original file into a new one:
  17
  18     $ ./python/demo/demo_timestretch_online.py loop.wav stretched_loop.wav 0.92`
  19
  20 Note: you might need to install additional modules to run some of the demos.
  21 Some demos use [matplotlib](http://matplotlib.org/) to draw plots, others use
  22 [PySoundCard](https://github.com/bastibe/PySoundCard) to play and record
  23 sounds.
  24
  25 Testing the Python module
  26 -------------------------
  27
  28 Python tests are in `python/tests` and use the [nose2 python package][nose2].
  29
  30 To run the all the python tests, use the script:
  31
  32     $ ./python/tests/run_all_tests
  33
  34 Each test script can also be called one at a time. For instance:
  35
  36     $ ./python/tests/test_note2midi.py -v
  37
  38 [nose2]: https://github.com/nose-devs/nose2
  39
  40 For more information about how this module works, please refer to the [Python/C
  41 API Reference Manual] (http://docs.python.org/c-api/index.html) and the
  42 [Numpy/C API Reference](http://docs.scipy.org/doc/numpy/reference/c-api.html).