Updates for release 4.0.8, including new python binding, new teststops.cpp program...
[rtaudio.git] / contrib / python / pyrtaudio / readme
1 PyRtAudio - a python wrapper around RtAudio that allows to perform audio i/o operations in real-time from the python language.\r
2 \r
3 By Antoine Lefebvre, 2011\r
4 \r
5 This software is in the development stage. Do not expect compatibility\r
6 with future versions. Comments, suggestions, new features, bug fixes,\r
7 etc. are welcome.\r
8 \r
9 \r
10 This distribution of PyRtAudio contains the following:\r
11 \r
12 - rtaudiomodule.cpp: the python wrapper code\r
13 - setup.py: a setup script use to compile and install PyRtAudio\r
14 - examples: a single PyRtAudioTest.py script\r
15 \r
16 INSTALLATION\r
17 \r
18 The compilation and installation of the PyRtAudio module is handled by\r
19 the python Distribution Utilities ("Distutils"). Provided that your\r
20 system has a C++ compiler and is properly configure, the following\r
21 command should be sufficient:\r
22 \r
23 >> python setup.py install\r
24 \r
25 Please refer to the distutils documentation for installation problems: http://docs.python.org/distutils/index.html \r
26 \r
27 LEGAL AND ETHICAL:\r
28 \r
29 The PyRtAudio license is the same as the RtAudio license:\r
30 \r
31     PyRtAudio: a python wrapper around RtAudio\r
32     Copyright (c)2011 Antoine Lefebvre\r
33 \r
34     Permission is hereby granted, free of charge, to any person\r
35     obtaining a copy of this software and associated documentation files\r
36     (the "Software"), to deal in the Software without restriction,\r
37     including without limitation the rights to use, copy, modify, merge,\r
38     publish, distribute, sublicense, and/or sell copies of the Software,\r
39     and to permit persons to whom the Software is furnished to do so,\r
40     subject to the following conditions:\r
41 \r
42     The above copyright notice and this permission notice shall be\r
43     included in all copies or substantial portions of the Software.\r
44 \r
45     Any person wishing to distribute modifications to the Software is\r
46     asked to send the modifications to the original developer so that\r
47     they can be incorporated into the canonical version.  This is,\r
48     however, not a binding provision of this license.\r
49 \r
50     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,\r
51     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\r
52     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\r
53     IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR\r
54     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF\r
55     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION\r
56     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
57 \r