2 Commits

Author SHA1 Message Date
Mo-way 8bcf03f288 Fix 404 Links in the Docs 2026-05-26 21:33:56 +02:00
Lars Immisch 2a2fa8f742 Update local build instructions wherever setup.py is greppable. 2025-12-10 23:05:14 +01:00
3 changed files with 16 additions and 35 deletions
+7 -12
View File
@@ -2,7 +2,7 @@
For documentation, see http://larsimmisch.github.io/pyalsaaudio/ For documentation, see http://larsimmisch.github.io/pyalsaaudio/
> Author: Casper Wilstrup (cwi@aves.dk) > Author: Casper Wilstrup (cwi@aves.dk)
> Maintainer: Lars Immisch (lars@ibp.de) > Maintainer: Lars Immisch (lars@ibp.de)
This package contains wrappers for accessing the This package contains wrappers for accessing the
@@ -46,14 +46,9 @@ First, get the sources and change to the source directory:
$ cd pyalsaaudio $ cd pyalsaaudio
``` ```
Then, build: Then, build and install:
``` ```
$ python setup.py build $ pip install .
```
And install:
```
$ sudo python setup.py install
``` ```
# Using the API # Using the API
@@ -62,8 +57,8 @@ distribution; it is also online on [http://larsimmisch.github.io/pyalsaaudio/](h
There are some example programs included with the source: There are some example programs included with the source:
* [playwav.py](https://github.com/larsimmisch/pyalsaaudio/blob/master/playwav.py) plays back a wav file * [playwav.py](./examples/playwav.py) plays back a wav file
* [playbacktest.py](https://github.com/larsimmisch/pyalsaaudio/blob/master/playbacktest.py) plays back raw sound data read from stdin * [playbacktest.py](./examples/playbacktest.py) plays back raw sound data read from stdin
* [recordtest.py](https://github.com/larsimmisch/pyalsaaudio/blob/master/recordtest.py) captures sound from the microphone and writes * [recordtest.py](./examples/recordtest.py) captures sound from the microphone and writes
it raw to stdout. it raw to stdout.
* [mixertest.py](https://github.com/larsimmisch/pyalsaaudio/blob/master/mixertest.py) can be used to manipulate the mixers. * [mixertest.py](./examples/mixertest.py) can be used to manipulate the mixers.
+8 -18
View File
@@ -1,28 +1,18 @@
# Make a new release # Make a new release
Update the version in setup.py Create and push a tag naming the version (i.e. 0.11.1):
pyalsa_version = '0.9.0' git tag 0.11.1
git push origin 0.11.1
Commit and push the update. This should trigger a build via a github actions and publish pre-built binaries to pypi.org
Create and push a tag naming the version (i.e. 0.9.0):
git tag 0.9.0
git push origin 0.9.0
Create the package:
python3 setup.py sdist
Upload the package
twine upload dist/*
Don't forget to update the documentation.
# Publish the documentation # Publish the documentation
All commits to main should trigger a rebuild of the documentation.
## Historical background
The documentation is published through the `gh-pages` branch. The documentation is published through the `gh-pages` branch.
To publish the documentation, you need to clone the `gh-pages` branch of this repository into To publish the documentation, you need to clone the `gh-pages` branch of this repository into
+1 -5
View File
@@ -86,11 +86,7 @@ ship with ALSA kernels.
To install, execute the following: --- :: To install, execute the following: --- ::
$ python setup.py build $ pip install .
And then as root: --- ::
# python setup.py install
******* *******