Changeset 4da317c


Ignore:
Timestamp:
Nov 21, 2018, 4:39:53 PM (13 months ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
feature/autosink, feature/constantq, feature/pitchshift, feature/pydocstrings, feature/timestretch, master
Children:
0c18603
Parents:
43885a7
Message:

[doc] remove installation instructions from python/README.md

File:
1 edited

Legend:

Unmodified
Added
Removed
  • python/README.md

    r43885a7 r4da317c  
    33
    44This module wraps the aubio library for Python using the numpy module.
    5 
    6 Using the Python aubio module
    7 -----------------------------
    8 
    9 After installing python-aubio, you will be able to import the aubio module:
    10 
    11     $ python
    12     [...]
    13     >>> import aubio
    14     >>> help(aubio.miditofreq)
    155
    166Finding some inspiration
     
    4838[nose2]: https://github.com/nose-devs/nose2
    4939
    50 Install in a virtualenv
    51 -----------------------
    52 
    53 You should be able to install python-aubio directly from the top source
    54 directory of aubio.
    55 
    56 First, create a virtualenv to hold the required python module:
    57 
    58     $ virtualenv pyaubio
    59     $ source pyaubio/bin/activate
    60 
    61 Now install and build the python extension using:
    62 
    63     $ pip install .
    64 
    65 Install requirements
    66 --------------------
    67 
    68 Before compiling this module, you must have compiled libaubio.
    69 
    70 A simple way to do this is with pip:
    71 
    72     $ pip install -r requirements.txt
    73 
    7440For more information about how this module works, please refer to the [Python/C
    7541API Reference Manual] (http://docs.python.org/c-api/index.html) and the
    7642[Numpy/C API Reference](http://docs.scipy.org/doc/numpy/reference/c-api.html).
    77 
    78 Compiling python aubio
    79 ----------------------
    80 
    81 To build the aubio Python module, run the following command from the top source
    82 directory of aubio:
    83 
    84     $ ./setup.py build
    85 
    86 Note: if libaubio was previously built using waf, the script will use it.
    87 Otherwise, the entire library will be built inside the python extension.
    88 
    89 To find out more about `setup.py` options:
    90 
    91     $ ./setup.py --help
    92 
    93 Installing
    94 ----------
    95 
    96 To install the Python module:
    97 
    98     $ ./setup.py install
    99 
    100 Alternatively, you may want to use the Python module without installing it by
    101 setting your PYTHONPATH, for instance as follows:
    102 
    103     $ export PYTHONPATH=$PYTHONPATH:$PWD/`ls -rtd build/lib.* | head -1`:$PWD/tests
    104 
Note: See TracChangeset for help on using the changeset viewer.