Add nix environment and update script

.envrc

@@ -0,0 +1 @@
+use nix

.gitignore

@@ -1,6 +1,7 @@
 *.pyc
 .mypy_cache
 .ruff_cache
+.direnv
 MANIFEST
 build
 dist

npins/default.nix

@@ -0,0 +1,47 @@
+# Generated by npins. Do not modify; will be overwritten regularly
+let
+  data = builtins.fromJSON (builtins.readFile ./sources.json);
+  version = data.version;
+
+  mkSource = spec:
+    assert spec ? type; let
+      path =
+        if spec.type == "Git" then mkGitSource spec
+        else if spec.type == "GitRelease" then mkGitSource spec
+        else if spec.type == "PyPi" then mkPyPiSource spec
+        else if spec.type == "Channel" then mkChannelSource spec
+        else builtins.throw "Unknown source type ${spec.type}";
+    in
+    spec // { outPath = path; };
+
+  mkGitSource = { repository, revision, url ? null, hash, ... }:
+    assert repository ? type;
+    # At the moment, either it is a plain git repository (which has an url), or it is a GitHub/GitLab repository
+    # In the latter case, there we will always be an url to the tarball
+    if url != null then
+      (builtins.fetchTarball {
+        inherit url;
+        sha256 = hash; # FIXME: check nix version & use SRI hashes
+      })
+    else assert repository.type == "Git"; builtins.fetchGit {
+      url = repository.url;
+      rev = revision;
+      # hash = hash;
+    };
+
+  mkPyPiSource = { url, hash, ... }:
+    builtins.fetchurl {
+      inherit url;
+      sha256 = hash;
+    };
+
+  mkChannelSource = { url, hash, ... }:
+    builtins.fetchTarball {
+      inherit url;
+      sha256 = hash;
+    };
+in
+if version == 3 then
+  builtins.mapAttrs (_: mkSource) data.pins
+else
+  throw "Unsupported format version ${toString version} in sources.json. Try running `npins upgrade`"

npins/sources.json

@@ -0,0 +1,11 @@
+{
+  "pins": {
+    "nixpkgs": {
+      "type": "Channel",
+      "name": "nixos-unstable",
+      "url": "https://releases.nixos.org/nixos/unstable/nixos-24.05pre588267.73de017ef2d1/nixexprs.tar.xz",
+      "hash": "1hcnwcankhqh0pk7g0njszm3553a6845dzy1yzq3jy5msrr4l2qy"
+    }
+  },
+  "version": 3
+}

pyproject.toml

@@ -14,6 +14,10 @@ authors = [
   {email = "[email protected]"},
   {name = "Christoph Reiter"}
 ]
+dependencies = [
+    # for @deprecated decorator
+    'typing_extensions>="4.5.0"; python_version<"3.13"',
+]
 classifiers = [
     "Programming Language :: Python :: 3",
     "Intended Audience :: Developers",
@@ -50,7 +54,8 @@ include = '\.pyi?$'
 skip = "*__pycache__*,.mypy_cache,.git,test,*.pyi"
 ignore-words-list = """
     astroid,
-    inout"""
+    inout,
+    gir"""
 
 [tool.isort]
 force_alphabetical_sort_within_sections = true

shell.nix

@@ -0,0 +1,63 @@
+let
+  sources = import ./npins;
+  pkgs = import sources.nixpkgs {};
+in
+pkgs.mkShell {
+  nativeBuildInputs = [
+    pkgs.gobject-introspection
+    (pkgs.python3.withPackages (pp: [
+      pp.black
+      pp.isort
+      pp.mypy
+      pp.pygobject3
+    ]))
+  ];
+
+  buildInputs = [
+    pkgs.appstream
+    pkgs.atk
+    pkgs.cinnamon.xapp
+    pkgs.farstream
+    pkgs.flatpak
+    pkgs.gdk-pixbuf
+    pkgs.geoclue2
+    pkgs.glib
+    pkgs.gnome-online-accounts
+    pkgs.gobject-introspection
+    pkgs.graphene
+    pkgs.gsound
+    pkgs.gspell
+    pkgs.gst_all_1.gst-plugins-bad # GstWebRTC
+    pkgs.gst_all_1.gst-plugins-base
+    pkgs.gst_all_1.gstreamer
+    pkgs.gtk3
+    pkgs.gtk4
+    pkgs.gtksourceview4
+    pkgs.gtksourceview5
+    pkgs.libgudev # required by manette
+    pkgs.libadwaita
+    pkgs.libappindicator-gtk3
+    pkgs.libayatana-appindicator
+    pkgs.libgit2-glib
+    pkgs.libhandy
+    pkgs.libmanette
+    pkgs.libnotify
+    pkgs.libpanel
+    pkgs.libportal
+    pkgs.librsvg
+    pkgs.libsecret
+    pkgs.libsoup
+    pkgs.libsoup_3
+    pkgs.ostree
+    pkgs.pango
+    pkgs.vte
+    pkgs.webkitgtk_6_0
+  ];
+
+  env = {
+    # Ensure the environment is not contaminated.
+    XDG_DATA_DIRS = "";
+    GI_GIR_PATH = "";
+    GI_TYPELIB_PATH = "";
+  };
+}