Changeset 155cc10 for doc/python_module.rst
- Timestamp:
- Mar 10, 2017, 2:26:32 PM (7 years ago)
- Branches:
- feature/autosink, feature/cnn, feature/cnn_org, feature/constantq, feature/crepe, feature/crepe_org, feature/pitchshift, feature/pydocstrings, feature/timestretch, fix/ffmpeg5, master, sampler
- Children:
- ee8a57c
- Parents:
- 00d0275 (diff), 67b6618 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the(diff)
links above to see all the changes relative to each parent. - File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
doc/python_module.rst
r00d0275 r155cc10 1 aubio Python module 2 =================== 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``: 12 13 .. code-block:: bash 14 15 $ pip install aubio 3 16 4 17 Building the module … … 9 22 .. code-block:: bash 10 23 11 $ cd python24 $ ./setup.py clean 12 25 $ ./setup.py build 13 26 $ sudo ./setup.py install 14 27 15 Using the module16 ---------------- 28 Using aubio in python 29 --------------------- 17 30 18 To use the python module, simply import aubio: 31 Once you have python-aubio installed, you should be able to run ``python -c 32 "import aubio; print(aubio.version)"``. 19 33 20 .. code-block:: python 34 A simple example 35 ................ 21 36 22 #! /usr/bin/env python 23 import aubio 37 Here is a :download:`simple script <../python/demos/demo_source_simple.py>` 38 that reads all the samples from a media file: 24 39 25 s = aubio.source(sys.argv[1], 0, 256) 26 while True: 27 samples, read = s() 28 print samples 29 if read < 256: break 40 .. literalinclude:: ../python/demos/demo_source_simple.py 41 :language: python 30 42 31 Check out the `python demos for aubio 32 <https://github.com/piem/aubio/blob/develop/python/demos/>`_ for more examples.43 Filtering an input sound file 44 ............................. 33 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
Note: See TracChangeset
for help on using the changeset viewer.