source: doc/python_module.rst @ 241e2fb

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

doc/python_module.rst: add note on pip, clean and remove cd python

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