Files
voculinux/packaging/nix/pywhispercpp.nix
T
c3c390f19d feat(nix): add flake package, NixOS and Home Manager modules (#936)
* feat(nix): add flake package, NixOS and Home Manager modules

Add a flake.nix plus packaging/nix derivations so Nix and NixOS users can
run and install Vocalinux declaratively, including via Home Manager.

- package.nix: buildPythonApplication with GTK3, libayatana-appindicator,
  IBus and libnotify typelibs; wraps the entry point with every host tool
  the injectors probe for (xdotool, wtype, ydotool, wl-clipboard, xclip,
  xsel, xprop, setxkbmap, ibus, gdbus, notify-send, paplay, aplay)
- pywhispercpp.nix: builds pywhispercpp from its vendored PyPI sdist
  (absent from nixpkgs, same gap as Debian/Fedora), static whisper.cpp,
  GGML_NATIVE=OFF for a portable baseline
- module.nix: NixOS module enabling hardware.uinput and installing the
  package; input/uinput group membership stays a per-user choice
- home-manager.nix: programs.vocalinux.enable installs into the profile
- docs/INSTALL.md gains a Nix / NixOS section; packaging/nix/README.md
  carries the usage snippets

Refs #931

* fix(nix): address review findings on imports check and docs

- pywhispercpp: check pywhispercpp.model and _pywhispercpp too, so the
  compiled binding is proven loadable, not just the package
- README Home Manager example: declare the nixpkgs/home-manager inputs
  and pass pkgs, which homeManagerConfiguration requires
- package.nix: use top-level xprop/setxkbmap attrs (xorg.* is deprecated)

---------

Co-authored-by: Jatin K Malik <jatinkrmalik@gmail.com>
2026-10-10 20:40:25 -07:00

99 lines
3.0 KiB
Nix

# pywhispercpp is not in nixpkgs (same gap the .deb/.rpm note in
# packaging/native/nfpm.yaml calls out for Debian and Fedora), so the flake
# builds it here. The PyPI sdist already vendors whisper.cpp and pybind11, so
# no extra source fetches are needed; setup.py drives CMake from build_ext.
{
lib,
buildPythonPackage,
fetchPypi,
setuptools,
wheel,
cmake,
numpy,
requests,
tqdm,
platformdirs,
autoPatchelfHook,
stdenv,
}:
buildPythonPackage rec {
pname = "pywhispercpp";
version = "1.5.1";
pyproject = true;
src = fetchPypi {
inherit pname version;
hash = "sha256-XfiX5d2dnxaAT8k3vYW59YgKCymlX4hDWF4OA9dhleU=";
};
# python -m build verifies every build-system.requires entry resolves to an
# installed Python package. The ones setup.py never imports are dropped:
# ninja is try/except'd (Unix Makefiles are the fallback), repairwheel only
# runs on Windows, setuptools-scm is unused, and cmake is a PATH tool, not a
# Python package.
postPatch = ''
substituteInPlace pyproject.toml \
--replace-fail ' "ninja",' "" \
--replace-fail ' "cmake>=3.12",' "" \
--replace-fail ' "repairwheel",' "" \
--replace-fail ' "setuptools-scm>=8"' ""
# setup() passes no version, so without setuptools-scm the wheel metadata
# lands as 0.0.0; get_version() reads PYWHISPERCPP_VERSION instead.
substituteInPlace setup.py \
--replace-fail ' name="pywhispercpp",' ' name="pywhispercpp", version=get_version(),'
'';
env = {
# The sdist ships no version.txt; setup.py falls back to this env var.
PYWHISPERCPP_VERSION = version;
# One static extension module (BUILD_SHARED_LIBS defaults ON upstream and
# would need $ORIGIN rpath repair that never runs outside cibuildwheel) and
# a portable baseline instead of -march=native.
CMAKE_ARGS = "-DBUILD_SHARED_LIBS=OFF -DGGML_NATIVE=OFF -DCMAKE_POSITION_INDEPENDENT_CODE=ON";
};
# env attrs are exported verbatim; expanding the core count needs a shell
# phase.
preBuild = ''
export CMAKE_BUILD_PARALLEL_LEVEL="$NIX_BUILD_CORES"
'';
# cmake is only here so setup.py's build_ext can invoke it; letting the
# cmake configure hook run standalone leaves a build/ dir that breaks the
# pypa wheel build.
dontUseCmakeConfigure = true;
nativeBuildInputs = [
cmake
autoPatchelfHook
];
build-system = [
setuptools
wheel
];
# libstdc++/libgomp for the compiled extension.
buildInputs = [ stdenv.cc.cc.lib ];
dependencies = [
numpy
requests
tqdm
platformdirs
];
# pywhispercpp.model pulls in the compiled _pywhispercpp extension, so
# checking all three proves the native binding loads, not just the package.
pythonImportsCheck = [ "pywhispercpp" "pywhispercpp.model" "_pywhispercpp" ];
meta = {
description = "Python bindings for whisper.cpp";
homepage = "https://github.com/absadiki/pywhispercpp";
license = lib.licenses.mit;
platforms = lib.platforms.linux;
};
}