Nix package for nunif IW3

[sezaru]

Hello, yesterday I created a Nix package for the IW3 application for my needs, maybe it can be of interest for other people, so I decided to post it here.

The package will only generate an executable for the IW3 gui app, not the rest (since I only use IW3), but it should be fairly easy to improve it with the other functionalities of the repo.

The package will also create a desktop icon for easy access and it will apply some patches so tmp/config data (iw3 config, presets, pretrained models, etc) are saved in ~/.config/nunif instead of the tmp dir inside the nunif directory (mandatory for Nix since the nunif dir will be read-only).

I also added another patch so opening IW3 stops the creation of a lock file in the user home file (it will create in the XDG_RUNTIME_DIR directory, and, if not set, it will fallback to /tmp).

Maybe these patches can be interesting to be applied to the main code if @nagadomi is interested.

Here are the patches and desktop icon used:
change_config_dir.patch
change_wx_lock_file_location.patch

Github doesn't allow .nix files to be uploaded, so here is the package.nix file implementing the package:

{ lib, stdenv, python3Packages, copyDesktopItems, makeDesktopItem, fetchgit, pkgs, ... }:
let
  rev = "2d3bd710dab28e85d3015d1c3104006544dc6d66";

  nunifSrc = fetchgit {
    url = "https://github.com/nagadomi/nunif";
    rev = rev;
    hash = "sha256-GuyTLUmselujZs7LagW3zGgD7CnVn8TYk57npdq2R3Q=";
  };
in
python3Packages.buildPythonApplication rec {
  pname = "nunif_iw3";
  version = rev;
  pyproject = false;

  src = nunifSrc;

  patches = [
    ./change_wx_lock_file_location.patch
    ./change_config_dir.patch
  ];

  nativeBuildInputs = [ pkgs.makeWrapper copyDesktopItems ];

  propagatedBuildInputs = with python3Packages; [
    requests
    tqdm
    scipy
    waitress
    bottle
    diskcache
    flake8
    psutil
    pyyaml
    platformdirs
    packaging
    filelock
    torch-bin
    torchvision-bin
    pillow
    pillow-heif
    wxpython
    av
    truststore
    safetensors
    einops
  ];

  desktopItems = [
    (makeDesktopItem {
      name = "Nunif IW3";
      exec = pname;
      icon = pname;
      desktopName = "Nunif IW3";
      comment = "Convert 2D videos into 3D ones";
      categories = [ "Utility" ];
    })
  ];

  buildPhase = ''
    runHook preBuild

    mkdir -p $out/${pname}
    cp -r * $out/${pname}

    mkdir -p $out/bin

    echo '#!${pkgs.bash}/bin/bash' > $out/run_gui.sh
    echo '${pkgs.python3}/bin/python3 -m iw3.gui' >> $out/run_gui.sh

    chmod +x $out/run_gui.sh

    runHook postBuild
  '';

  installPhase = ''
    runHook preInstall

    makeWrapper $out/run_gui.sh $out/bin/${pname} \
      --set PYTHONPATH "$PYTHONPATH:$out/${pname}:$out/${pkgs.python3.sitePackages}" \
      --set GSETTINGS_SCHEMA_DIR "${pkgs.glib.getSchemaPath pkgs.gtk3}" \

    install -Dm444 \
      ${./icon.png} \
      $out/share/icons/hicolor/256x256/apps/${pname}.png

    runHook postInstall
  '';
}

[nagadomi]

Hello. I update the code every day, so I do not use frozen packages and I want users to run git pull every day as well. 😄

However, I understand that there are cases where the directories with write access need to be changed, so I plan to provide a way to set them using environment variables.
For example, users will be able to run it like this:

NUNIF_HOME=~/.config/nunif/ python -m iw3.gui

Or set it in .*rc file.
With this, the patch above should no longer be necessary.

Regarding the default paths, I do not plan to change them because I intentionally avoid accessing files outside the repository directory and many users are already using the current settings.

[nagadomi]

I merged the above changes into the dev branch in #549. They may be merged into master much later.

[sezaru]

Yep, I totally agree with you that it should be environment variables instead of a fixed path, when I did the patch I just wanted to make it work in my Nix system, but now that you mentioned it, I should've done it with env variables instead haha