chore: modernise library

.github/workflows/docs.yml

@@ -0,0 +1,40 @@
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - name: Install ALSA headers
+        run: sudo apt-get install libasound2-dev
+      - name: Build HTML documentation
+        run: make -C doc html
+      - name: Upload artifacts
+        uses: actions/upload-pages-artifact@v4
+        with:
+          path: doc/html
+
+  deploy:
+    runs-on: ubuntu-latest
+    needs: build
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/release.yml

@@ -0,0 +1,58 @@
+# Adapted from: https://github.com/pypa/cibuildwheel/blob/main/examples/github-deploy.yml
+
+on:
+  workflow_dispatch:
+  push:
+    tags: "*"
+
+jobs:
+  build_wheels:
+    name: Build wheels on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os:
+          - ubuntu-24.04
+          - ubuntu-24.04-arm
+    steps:
+      - uses: actions/checkout@v5
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - name: Build wheels
+        run: make build_wheels
+      - uses: actions/upload-artifact@v4
+        with:
+          name: cibw-wheels-${{ matrix.os }}-${{ strategy.job-index }}
+          path: ./wheelhouse/*.whl
+
+  build_sdist:
+    name: Build source distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - name: Build sdist
+        run: make build_sdist
+      - uses: actions/upload-artifact@v4
+        with:
+          name: cibw-sdist
+          path: dist/*.tar.gz
+
+  upload_pypi:
+    needs: [build_wheels, build_sdist]
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v5
+        with:
+          # unpacks all CIBW artifacts into dist/
+          pattern: cibw-*
+          path: dist
+          merge-multiple: true
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        # TODO: delete below once workflow is proved functional
+        with:
+          repository-url: https://test.pypi.org/legacy/

.gitignore

@@ -8,7 +8,8 @@ doc/_build/
 gh-pages/
 build/
 dist/
+wheelhouse/
 .vscode/
 /__pycache__/
-/pyalsaaudio.egg-info/
+*.egg-info/
 *.raw

MANIFEST.in

@@ -1,6 +1,2 @@
-include *.py
-include *.pyi
-include CHANGES
-include TODO
-include LICENSE
-recursive-include doc *.html *.gif *.png *.css *.py *.rst *.js *.json  Makefile
+graft doc/
+graft examples/

Makefile

@@ -0,0 +1,16 @@
+.PHONY: lint test build_wheels build_sdist build
+
+lint:
+	uv run --group lint pyright; \
+	uv run --group lint stubtest alsaaudio
+
+test:
+	uv run tests/test.py
+
+build_wheels:
+	uvx cibuildwheel==3.1.4
+
+build_sdist:
+	uv build --sdist
+
+build: build_sdist build_wheels

ci/setup_cibuildwheel.sh

@@ -0,0 +1,22 @@
+#!/bin/sh
+
+# NOTE: ensure to use the correct package manager depending on the manylinux
+# image used.
+
+if which yum; then
+	yum install -y alsa-lib-devel
+	exit
+fi
+
+if which apk; then
+	apk add alsa-lib-dev
+	exit
+fi
+
+if which apt-get; then
+	apt-get install -y libasound2-dev
+	exit
+fi
+
+echo "Cannot install ALSA headers! No package manager detected"
+exit 1

doc/Makefile

@@ -3,7 +3,7 @@
 
 # You can set these variables from the command line.
 SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build
+SPHINXBUILD   = uv run --group doc sphinx-build
 PAPER         =
 
 # Internal variables.
@@ -70,9 +70,3 @@ linkcheck:
 	@echo
 	@echo "Link check complete; look for any errors in the above output " \
 	      "or in linkcheck/output.txt."
-
-gh-pages: html
-	cd gh-pages; git pull --rebase; cd ..; cp -r ./html/* gh-pages
-
-publish: gh-pages
-	cd gh-pages; git commit -a; git push; cd ..

doc/conf.py

@@ -20,9 +20,8 @@
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
 
-import sys
-sys.path.insert(0, '..')
-from setup import pyalsa_version
+from importlib.metadata import version
+pyalsa_version = version("pyalsaaudio")
 
 
 # -- General configuration ------------------------------------------------

pyproject.toml

@@ -0,0 +1,70 @@
+[project]
+name = "pyalsaaudio"
+version = "0.11.0"
+description = "ALSA bindings"
+readme.text = """
+This package contains wrappers for accessing the ALSA API from Python.
+It is fairly complete for PCM devices and Mixer access.
+"""
+readme.content-type = "text/plain"
+
+license.file = "LICENSE"
+
+# NOTE: license as a table has been deprecated by PEP-639, however support in
+# setuptools has been introduced in v77.0 which is not installable on Python
+# 3.9. Since this project doesn't constraint the minimum python version, we have
+# to stick to the legacy `license` definition for now.
+
+# license="PSF-2.0"
+# license-files=["LICENSE"]
+
+classifiers = [
+	"Development Status :: 4 - Beta",
+	"Intended Audience :: Developers",
+	"Operating System :: POSIX :: Linux",
+	"Programming Language :: Python :: 3",
+	"Topic :: Multimedia :: Sound/Audio",
+	"Topic :: Multimedia :: Sound/Audio :: Mixers",
+	"Topic :: Multimedia :: Sound/Audio :: Players",
+	"Topic :: Multimedia :: Sound/Audio :: Capture/Recording",
+]
+
+[[project.authors]]
+name = "Casper Wilstrup"
+email = "[email protected]"
+
+[[project.maintainers]]
+name = "Lars Immisch"
+email = "[email protected]"
+
+[project.urls]
+homepage = "http://larsimmisch.github.io/pyalsaaudio/"
+source = "https://github.com/larsimmisch/pyalsaaudio"
+documentation = "https://larsimmisch.github.io/pyalsaaudio/"
+issues = "https://github.com/larsimmisch/pyalsaaudio/issues"
+
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+
+[tool.setuptools]
+ext-modules = [
+	{ name = "alsaaudio", sources = ["src/alsaaudio.c"], libraries = ["asound"] }
+]
+
+
+[tool.cibuildwheel]
+build-frontend = "build[uv]"
+before-all = "ci/setup_cibuildwheel.sh"
+
+
+[dependency-groups]
+lint = [
+	"mypy>=1.17.1",
+	"pyright>=1.1.403",
+]
+doc = [
+	"sphinx>=8.1.3",
+]