History

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

Paul Brossier committed 7 years ago

Commit 4da317c1 parent 43885a71 file · +0 −62Browse files

Unified · Split

python/README.md+0−62
@@ -3,16 +3,6 @@ Python aubio module · 2 unmodified lines
3 3
4This module wraps the aubio library for Python using the numpy module.4This module wraps the aubio library for Python using the numpy module.
5 5
6Using the Python aubio module
7-----------------------------
8
9After installing python-aubio, you will be able to import the aubio module:
10
11 $ python
12 [...]
13 >>> import aubio
14 >>> help(aubio.miditofreq)
15
16Finding some inspiration6Finding some inspiration
17------------------------7------------------------
18 8
@@ -47,58 +37,6 @@ Each test script can also be called one at a time. For instance: · 28 unmodified lines
47 37
48[nose2]: https://github.com/nose-devs/nose238[nose2]: https://github.com/nose-devs/nose2
49 39
50Install in a virtualenv
51-----------------------
52
53You should be able to install python-aubio directly from the top source
54directory of aubio.
55
56First, create a virtualenv to hold the required python module:
57
58 $ virtualenv pyaubio
59 $ source pyaubio/bin/activate
60
61Now install and build the python extension using:
62
63 $ pip install .
64
65Install requirements
66--------------------
67
68Before compiling this module, you must have compiled libaubio.
69
70A simple way to do this is with pip:
71
72 $ pip install -r requirements.txt
73
74For more information about how this module works, please refer to the [Python/C40For more information about how this module works, please refer to the [Python/C
75API Reference Manual] (http://docs.python.org/c-api/index.html) and the41API Reference Manual] (http://docs.python.org/c-api/index.html) and the
76[Numpy/C API Reference](http://docs.scipy.org/doc/numpy/reference/c-api.html).42[Numpy/C API Reference](http://docs.scipy.org/doc/numpy/reference/c-api.html).
77
78Compiling python aubio
79----------------------
80
81To build the aubio Python module, run the following command from the top source
82directory of aubio:
83
84 $ ./setup.py build
85
86Note: if libaubio was previously built using waf, the script will use it.
87Otherwise, the entire library will be built inside the python extension.
88
89To find out more about `setup.py` options:
90
91 $ ./setup.py --help
92
93Installing
94----------
95
96To install the Python module:
97
98 $ ./setup.py install
99
100Alternatively, you may want to use the Python module without installing it by
101setting your PYTHONPATH, for instance as follows:
102
103 $ export PYTHONPATH=$PYTHONPATH:$PWD/`ls -rtd build/lib.* | head -1`:$PWD/tests
104

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t