pkgs/applications/office/paperwork/paperwork-gtk.nix

   1 { lib
   2 , python3Packages
   3 , gtk3
   4 , cairo
   5 , adwaita-icon-theme
   6 , librsvg
   7 , xvfb-run
   8 , dbus
   9 , libnotify
  10 , wrapGAppsHook3
  11 , fetchFromGitLab
  12 , which
  13 , gettext
  14 , gobject-introspection
  15 , gdk-pixbuf
  16 , texliveSmall
  17 , imagemagick
  18 , perlPackages
  19 , writeScript
  20 }:
  21
  22 let
  23   documentation_deps = [
  24     (texliveSmall.withPackages (ps: with ps; [ wrapfig gensymb ]))
  25     xvfb-run
  26     imagemagick
  27     perlPackages.Po4a
  28   ];
  29   inherit (import ./src.nix { inherit fetchFromGitLab; }) version src sample_documents;
  30 in
  31
  32 python3Packages.buildPythonApplication rec {
  33   inherit src version;
  34   pname = "paperwork";
  35   format = "pyproject";
  36
  37   sample_docs = sample_documents // {
  38     # a trick for the update script
  39     name = "sample_documents";
  40     src = sample_documents;
  41   };
  42
  43   sourceRoot = "${src.name}/paperwork-gtk";
  44
  45   postPatch = ''
  46     chmod a+w -R ..
  47     patchShebangs ../tools
  48
  49     export HOME=$(mktemp -d)
  50   '';
  51
  52   preBuild = ''
  53     make l10n_compile
  54   '';
  55
  56   postInstall = ''
  57     # paperwork-shell needs to be re-wrapped with access to paperwork
  58     for exe in paperwork-cli paperwork-json; do
  59       cp ${python3Packages.paperwork-shell}/bin/.$exe-wrapped $out/bin/$exe
  60     done
  61     # install desktop files and icons
  62     XDG_DATA_HOME=$out/share $out/bin/paperwork-gtk install --user
  63
  64     # fixes [WARNING] [openpaperwork_core.resources.setuptools] Failed to find
  65     # resource file paperwork_gtk.icon.out/paperwork_128.png, tried at path
  66     # /nix/store/3n5lz6y8k9yks76f0nar3smc8djan3xr-paperwork-2.0.2/lib/python3.8/site-packages/paperwork_gtk/icon/out/paperwork_128.png.
  67     site=$out/${python3Packages.python.sitePackages}/paperwork_gtk
  68     for i in $site/data/paperwork_*.png; do
  69       ln -s $i $site/icon/out;
  70     done
  71
  72     export XDG_DATA_DIRS=$XDG_DATA_DIRS:${adwaita-icon-theme}/share
  73     # build the user manual
  74     PATH=$out/bin:$PATH PAPERWORK_TEST_DOCUMENTS=${sample_docs} make data
  75     for i in src/paperwork_gtk/model/help/out/*.pdf; do
  76       install -Dt $site/model/help/out $i
  77     done
  78   '';
  79
  80   nativeCheckInputs = [ dbus ];
  81
  82   nativeBuildInputs = [
  83     wrapGAppsHook3
  84     gobject-introspection
  85     python3Packages.setuptools-scm
  86     (lib.getBin gettext)
  87     which
  88     gdk-pixbuf # for the setup hook
  89   ] ++ documentation_deps;
  90
  91   buildInputs = [
  92     adwaita-icon-theme
  93     libnotify
  94     librsvg
  95     gtk3
  96     cairo
  97   ];
  98
  99   dontWrapGApps = true;
 100
 101   preFixup = ''
 102     makeWrapperArgs+=("''${gappsWrapperArgs[@]}")
 103   '';
 104
 105   checkPhase = ''
 106     runHook preCheck
 107
 108     # A few parts of chkdeps need to have a display and a dbus session, so we not
 109     # only need to run a virtual X server + dbus but also have a large enough
 110     # resolution, because the Cairo test tries to draw a 200x200 window.
 111     xvfb-run -s '-screen 0 800x600x24' dbus-run-session \
 112       --config-file=${dbus}/share/dbus-1/session.conf \
 113       $out/bin/paperwork-gtk chkdeps
 114
 115     $out/bin/paperwork-cli chkdeps
 116     $out/bin/paperwork-json chkdeps
 117
 118     # content of make test, without the dep on make install
 119     python -m unittest discover --verbose -s tests
 120
 121     runHook postCheck
 122   '';
 123
 124   propagatedBuildInputs = with python3Packages; [
 125     paperwork-backend
 126     paperwork-shell
 127     openpaperwork-gtk
 128     openpaperwork-core
 129     pypillowfight
 130     pyxdg
 131     setuptools
 132   ];
 133
 134   disallowedRequisites = documentation_deps;
 135
 136   passthru.updateScript = writeScript "update.sh" ''
 137     #!/usr/bin/env nix-shell
 138     #!nix-shell -i bash -p curl common-updater-scripts
 139     version=$(list-git-tags | sed 's/^v//' | sort -V | tail -n1)
 140     update-source-version paperwork "$version" --file=pkgs/applications/office/paperwork/src.nix
 141     docs_version="$(curl https://gitlab.gnome.org/World/OpenPaperwork/paperwork/-/raw/$version/paperwork-gtk/src/paperwork_gtk/model/help/screenshot.sh | grep TEST_DOCS_TAG= | cut -d'"' -f2)"
 142     update-source-version paperwork.sample_docs "$docs_version" --file=pkgs/applications/office/paperwork/src.nix --version-key=rev
 143   '';
 144
 145   meta = {
 146     description = "Personal document manager for scanned documents";
 147     homepage = "https://openpaper.work/";
 148     license = lib.licenses.gpl3Plus;
 149     maintainers = with lib.maintainers; [ aszlig symphorien ];
 150     platforms = lib.platforms.linux;
 151   };
 152 }