source: doc/python_module.rst @ 8470144

feature/autosinkfeature/cnnfeature/cnn_orgfeature/constantqfeature/crepefeature/crepe_orgfeature/pitchshiftfeature/pydocstringsfeature/timestretchfix/ffmpeg5pitchshiftsamplertimestretchyinfft+
Last change on this file since 8470144 was 34abeaf, checked in by Paul Brossier <piem@piem.org>, 9 years ago

doc/*.rst: add simple documentation basis

  • Property mode set to 100644
File size: 658 bytes
RevLine 
[34abeaf]1aubio Python module
2===================
3
4Building the module
5-------------------
6
7From ``aubio`` source directory, run the following:
8
9.. code-block:: bash
10
11    $ cd python
12    $ ./setup.py build
13    $ sudo ./setup.py install
14
15Using the module
16----------------
17
18To use the python module, simply import aubio:
19
20.. code-block:: python
21
22        #! /usr/bin/env python
23        import aubio
24
25        s = aubio.source(sys.argv[1], 0, 256)
26        while True:
27          samples, read = s()
28          print samples
29          if read < 256: break
30
31Check out the `python demos for aubio
32<https://github.com/piem/aubio/blob/develop/python/demos/>`_ for more examples.
33
Note: See TracBrowser for help on using the repository browser.