Showing the changes to doc/python_module.rst (1 of 15 files). Show all
Unified · Split
| @@ -3,28 +3,50 @@ · 2 unmodified lines | |||
| 3 | Installing aubio for Python | 3 | Installing aubio for Python |
| 4 | =========================== | 4 | =========================== |
| 5 | 5 | ||
| 6 | The aubio extension for Python is available for Python 2.7 and Python 3. | 6 | aubio is available as a package for Python 2.7 and Python 3. The aubio |
| 7 | extension is written C using the `Python/C`_ and the `Numpy/C`_ APIs. | ||
| 8 | |||
| 9 | .. _Python/C: https://docs.python.org/c-api/index.html | ||
| 10 | .. _Numpy/C: https://docs.scipy.org/doc/numpy/reference/c-api.html | ||
| 11 | |||
| 12 | For general documentation on how to install Python packages, see `Installing | ||
| 13 | Packages`_. | ||
| 7 | 14 | ||
| 8 | Installing aubio with pip | 15 | Installing aubio with pip |
| 9 | ------------------------- | 16 | ------------------------- |
| 10 | 17 | ||
| 11 | aubio can now be installed using ``pip``: | 18 | aubio can be installed from `PyPI`_ using ``pip``: |
| 12 | 19 | ||
| 13 | .. code-block:: console | 20 | .. code-block:: console |
| 14 | 21 | ||
| 15 | $ pip install aubio | 22 | $ pip install aubio |
| 16 | 23 | ||
| 17 | Building the module | 24 | See also `Installing from PyPI`_ for general documentation. |
| 18 | ------------------- | 25 | |
| 26 | .. note:: | ||
| 27 | |||
| 28 | aubio is currently a `source only`_ package, so you will need a compiler to | ||
| 29 | install it from `PyPI`_. See also `Installing aubio with conda`_ for | ||
| 30 | pre-compiled binaries. | ||
| 31 | |||
| 32 | .. _PyPI: https://pypi.python.org/pypi/aubio | ||
| 33 | .. _Installing Packages: https://packaging.python.org/tutorials/installing-packages/ | ||
| 34 | .. _Installing from PyPI: https://packaging.python.org/tutorials/installing-packages/#installing-from-pypi | ||
| 35 | .. _source only: https://packaging.python.org/tutorials/installing-packages/#source-distributions-vs-wheels | ||
| 36 | |||
| 37 | Installing aubio with conda | ||
| 38 | --------------------------- | ||
| 19 | 39 | ||
| 20 | From ``aubio`` source directory, run the following: | 40 | `Conda packages`_ are available through the `conda-forge`_ channel for Linux, |
| 41 | macOS, and Windows: | ||
| 21 | 42 | ||
| 22 | .. code-block:: console | 43 | .. code-block:: console |
| 23 | 44 | ||
| 24 | $ ./setup.py clean | 45 | $ conda config --add channels conda-forge |
| 25 | $ ./setup.py build | 46 | $ conda install -c conda-forge aubio |
| 26 | $ sudo ./setup.py install | ||
| 27 | 47 | ||
| 48 | .. _Conda packages: https://anaconda.org/conda-forge/aubio | ||
| 49 | .. _conda-forge: https://conda-forge.org/ | ||
| 28 | 50 | ||
| 29 | .. _py-doubleprecision: | 51 | .. _py-doubleprecision: |
| 30 | 52 | ||
| @@ -67,14 +89,15 @@ The command line `aubio` is also installed: · 36 unmodified lines | |||
| 67 | Python tests | 89 | Python tests |
| 68 | ------------ | 90 | ------------ |
| 69 | 91 | ||
| 70 | A number of python tests are provided. To run them, use [pytest] from the | 92 | A number of Python tests are provided in the `python/tests`_ folder. To run |
| 71 | aubio source tree: | 93 | them, install `pytest`_ and run it from the aubio source directory: |
| 94 | |||
| 95 | .. code-block:: console | ||
| 72 | 96 | ||
| 97 | $ pip install pytest | ||
| 98 | $ git clone https://git.aubio.org/aubio/aubio | ||
| 73 | $ cd aubio | 99 | $ cd aubio |
| 74 | $ pytest | 100 | $ pytest |
| 75 | 101 | ||
| 76 | Each test script can also be called individually. For instance: | 102 | .. _python/tests: https://github.com/aubio/aubio/blob/master/python/tests |
| 77 | 103 | .. _pytest: https://pytest.org | |
| 78 | $ ./python/tests/test_note2midi.py -v | ||
| 79 | |||
| 80 | [pytest]: https://pytest.org | ||