forked from auracaster/pyalsaaudio
Prepare for github
This commit is contained in:
1
.gitignore
vendored
Normal file
1
.gitignore
vendored
Normal file
@@ -0,0 +1 @@
|
||||
gh-pages/
|
||||
@@ -1,15 +1,13 @@
|
||||
PyAlsaAudio
|
||||
===========
|
||||
# PyAlsaAudio
|
||||
|
||||
Author: Casper Wilstrup (cwi@aves.dk)
|
||||
Maintainer: Lars Immisch (lars@ibp.de)
|
||||
|
||||
This package contains wrappers for accessing the ALSA api from Python. It
|
||||
is currently fairly complete for PCM devices. My next goal is to have
|
||||
complete mixer supports as well. MIDI sequencer support is low on my
|
||||
priority list, but volunteers are welcome.
|
||||
is currently fairly complete for PCM devices, and has some support for mixers
|
||||
|
||||
If you find bugs in the wrappers please notify me on email. Please
|
||||
don't send bug reports regarding ALSA specifically. There are several
|
||||
If you find bugs in the wrappers please open an issue in the issue tracker.
|
||||
Please don't send bug reports regarding ALSA specifically. There are several
|
||||
bugs in this api, and those should be reported to the ALSA team - not
|
||||
me.
|
||||
|
||||
@@ -19,37 +17,35 @@ for anything you wish (even commercial purposes). There is no warranty
|
||||
whatsoever.
|
||||
|
||||
|
||||
Installation
|
||||
============
|
||||
# Installation
|
||||
|
||||
Note: the wrappers link with the alsasound library alsa (from the alsa-lib
|
||||
package). Verify that this is installed by looking for /usr/lib/libasound.so
|
||||
before building. The libasound development files are also neccesary. On debian
|
||||
and derivatives, this is achieved by installing the alsalib-dev package.
|
||||
and derivatives, this is achieved by installing the `alsalib-dev` package.
|
||||
|
||||
Naturally you also need to use a kernel with proper ALSA
|
||||
support. This is the default in Linux kernel 2.6 and later. If you are using
|
||||
kernel version 2.4 you may need to install the ALSA patches yourself - although
|
||||
most distributions ship with ALSA kernels.
|
||||
support.
|
||||
|
||||
To install, execute the following:
|
||||
```
|
||||
$ python setup.py build
|
||||
|
||||
```
|
||||
And then as root:
|
||||
# python setup.py install
|
||||
```
|
||||
# sudo python setup.py install
|
||||
```
|
||||
|
||||
|
||||
Using the API
|
||||
=============
|
||||
# Using the API
|
||||
There is a reasonably useful API documentation included in the module
|
||||
documentation, which can be found in the doc subdirectory of the source
|
||||
distribution.
|
||||
|
||||
There are also three example programs included with the source:
|
||||
'playbacktest.py' which plays back raw sound data read from
|
||||
`playbacktest.py` which plays back raw sound data read from
|
||||
stdin
|
||||
|
||||
'recordtest.py' which captures sound from the microphone at writes
|
||||
`recordtest.py` which captures sound from the microphone at writes
|
||||
it raw to stdout.
|
||||
|
||||
'mixertest.py' which can be used to manipulate the mixers.
|
||||
`mixertest.py` which can be used to manipulate the mixers.
|
||||
@@ -73,5 +73,8 @@ linkcheck:
|
||||
@echo "Link check complete; look for any errors in the above output " \
|
||||
"or in linkcheck/output.txt."
|
||||
|
||||
upload: html
|
||||
scp -r ./html/* $(SFUSER),pyalsaaudio@web.sourceforge.net:htdocs
|
||||
gh-pages: html
|
||||
cp -r ./html/* gh-pages
|
||||
|
||||
publish: gh-pages
|
||||
cd gh-pages; git commit -a; git push; cd ..
|
||||
7
doc/README.md
Normal file
7
doc/README.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# Publish the documentation
|
||||
|
||||
The documentation is published through the `gh-pages` branch.
|
||||
|
||||
To publish the documentation, do:
|
||||
|
||||
git clone -b gh-pages git@github.com:larsimmisch/pyalsaaudio.git gh-pages
|
||||
@@ -9,12 +9,12 @@ alsaaudio documentation
|
||||
libalsaaudio
|
||||
|
||||
|
||||
SourceForge pages
|
||||
Github pages
|
||||
=================
|
||||
|
||||
* `Project page <http://sourceforge.net/projects/pyalsaaudio/>`_
|
||||
* `Download <http://sourceforge.net/project/showfiles.php?group_id=120651">`_
|
||||
* `Bug tracker <http://sourceforge.net/tracker/?group_id=120651>`_
|
||||
* `Project page <https://github.com/larsimmisch/pyalsaaudio/>`_
|
||||
* `Download from pypi <https://pypi.python.org/pypi/pyalsaaudio>`_
|
||||
* `Bug tracker <https://github.com/larsimmisch/pyalsaaudio/issues>`_
|
||||
|
||||
|
||||
Indices and tables
|
||||
|
||||
4
setup.py
4
setup.py
@@ -8,7 +8,7 @@ from distutils.core import setup
|
||||
from distutils.extension import Extension
|
||||
from sys import version
|
||||
|
||||
pyalsa_version = '0.6'
|
||||
pyalsa_version = '0.8'
|
||||
|
||||
# patch distutils if it's too old to cope with the "classifiers" or
|
||||
# "download_url" keywords
|
||||
@@ -30,7 +30,7 @@ if __name__ == '__main__':
|
||||
maintainer_email = 'lars@ibp.de',
|
||||
license='PSF',
|
||||
platforms=['posix'],
|
||||
url='http://pyalsaaudio.sourceforge.net/',
|
||||
url='http://larsimmisch.github.io/pyalsaaudio/',
|
||||
classifiers = [
|
||||
'Development Status :: 4 - Beta',
|
||||
'Intended Audience :: Developers',
|
||||
|
||||
Reference in New Issue
Block a user