flake.nix

{
  description = "Declarative and reproducible Jupyter environments - powered by Nix";

  nixConfig.extra-substituters = [
    "https://tweag-jupyter.cachix.org"
  ];
  nixConfig.extra-trusted-public-keys = [
    "tweag-jupyter.cachix.org-1:UtNH4Zs6hVUFpFBTLaA4ejYavPo5EFFqgd7G7FxGW9g="
  ];

  inputs.nixpkgs.url = "github:nixos/nixpkgs/nixpkgs-unstable";
  inputs.nixpkgs-stable.url = "github:nixos/nixpkgs/nixos-24.11";
  inputs.nixpkgs-master.url = "github:nixos/nixpkgs/master";
  inputs.flake-compat.url = "github:edolstra/flake-compat";
  inputs.flake-compat.flake = false;
  inputs.flake-utils.url = "github:numtide/flake-utils";
  inputs.ihaskell.url = "github:ihaskell/ihaskell";
  inputs.ihaskell.inputs.flake-utils.follows = "flake-utils";
  inputs.ihaskell.inputs.nixpkgsMaster.follows = "nixpkgs-master";
  inputs.ihaskell.inputs.nixpkgs24_11.follows = "nixpkgs-stable";
  inputs.nix-dart.url = "github:djacu/nix-dart";
  inputs.nix-dart.inputs.nixpkgs.follows = "nixpkgs";
  inputs.nix-dart.inputs.flake-utils.follows = "flake-utils";
  inputs.npmlock2nix.url = "github:nix-community/npmlock2nix";
  inputs.npmlock2nix.flake = false;
  inputs.opam-nix.url = "github:tweag/opam-nix";
  inputs.opam-nix.inputs.flake-compat.follows = "";
  inputs.opam-nix.inputs.flake-utils.follows = "flake-utils";
  inputs.opam-nix.inputs.nixpkgs.follows = "nixpkgs";
  inputs.pre-commit-hooks.url = "github:cachix/pre-commit-hooks.nix";
  inputs.pre-commit-hooks.inputs.nixpkgs.follows = "nixpkgs";
  inputs.pre-commit-hooks.inputs.flake-compat.follows = "";
  # https://github.com/nix-community/poetry2nix/pull/1329
  inputs.poetry2nix.url = "github:nix-community/poetry2nix";
  inputs.poetry2nix.inputs.flake-utils.follows = "flake-utils";
  inputs.poetry2nix.inputs.nixpkgs.follows = "nixpkgs";
  inputs.poetry2nix.inputs.treefmt-nix.follows = "";
  inputs.rust-overlay.url = "github:oxalica/rust-overlay";
  inputs.rust-overlay.inputs.nixpkgs.follows = "nixpkgs";

  outputs = {
    self,
    nixpkgs,
    nixpkgs-stable,
    flake-compat,
    flake-utils,
    ihaskell,
    nix-dart,
    npmlock2nix,
    opam-nix,
    pre-commit-hooks,
    poetry2nix,
    rust-overlay,
    ...
  } @ inputs: let
    inherit (nixpkgs) lib;

    SYSTEMS = [
      "x86_64-linux"
      "x86_64-darwin"
      "aarch64-linux"
      "aarch64-darwin"
    ];

    welcomeText = ''
      You have created a jupyenv template.

      Run `nix run` to immediately try it out.

      See the jupyenv documentation for more information.

        https://jupyenv.io/documentation/getting-started/
    '';

    kernelLib = import ./lib/kernels.nix {inherit self lib;};
  in
    (flake-utils.lib.eachSystem SYSTEMS (
      system: let
        pkgs = nixpkgs.legacyPackages.${system}.appendOverlays [
          poetry2nix.overlays.default
        ];

        python = pkgs.python3;

        baseArgs = {
          inherit self system;
        };

        pre-commit = pre-commit-hooks.lib.${system}.run {
          src = self;
          hooks = {
            alejandra.enable = true;
            typos = {
              enable = true;
              settings.write = true;
              types = ["file"];
              files = "\\.((txt)|(md)|(nix)|\\d)$";
            };
          };
          excludes = ["^\\.jupyter/"]; # JUPYTERLAB_DIR
        };

        update-poetry-lock =
          pkgs.writeShellApplication
          {
            name = "update-poetry-lock";
            runtimeInputs = [
              pkgs.poetry
            ];
            text = ''
              shopt -s globstar
              for lock in **/poetry.lock; do
              (
                echo Updating "$lock"
                cd "$(dirname "$lock")"
                poetry update
              )
              done
            '';
          };

        jupyenvLib = lib.makeScope lib.callPackageWith (final: {
          inherit self system pkgs lib python nix-dart baseArgs kernelLib;
          docsLib = final.callPackage ./lib/docs.nix {};
          jupyterLib = final.callPackage ./lib/jupyter.nix {};
        });
        inherit (jupyenvLib) docsLib jupyterLib;

        examples = kernelLib.mapKernelsFromPath (self + /examples) ["example"];
        exampleJupyterlabKernelsNew = (
          lib.mapAttrs'
          (
            name: value:
              lib.nameValuePair
              ("jupyterlab-kernel-" + name)
              (jupyterLib.mkJupyterlabNew value)
          )
          examples
        );

        exampleJupyterlabAllKernelsNew =
          jupyterLib.mkJupyterlabNew (builtins.attrValues examples);
      in {
        lib =
          jupyterLib
          // kernelLib
          // {};
        packages =
          rec {
            jupyterlab-new = jupyterLib.mkJupyterlabNew ./config.nix;
            jupyterlab = jupyterLib.mkJupyterlabNew {};
            jupyterlab-all-example-kernels = exampleJupyterlabAllKernelsNew;
            pub2nix-lock = nix-dart.packages."${system}".pub2nix-lock;
            inherit update-poetry-lock;
            inherit (docsLib) docs mkdocs;
            default = jupyterlab;
          }
          // exampleJupyterlabKernelsNew;
        devShells.default = pkgs.mkShell {
          packages = [
            pkgs.alejandra
            pkgs.typos
            pkgs.poetry2nix.cli
            # FIXME: pkgs.poetry is segfaulting on nixpkgs-unstable & poetry2nix
            # https://github.com/nix-community/poetry2nix/issues/1291
            pkgs.poetry
            self.packages."${system}".update-poetry-lock
          ];
          shellHook = ''
            ${pre-commit.shellHook}
          '';
        };
        checks = {
          inherit pre-commit;
        };
        apps = {
          update-poetry-lock =
            flake-utils.lib.mkApp
            {drv = self.packages."${system}".update-poetry-lock;};
        };
      }
    ))
    // {
      # https://flake.parts/options/jupyenv
      flakeModule = {
        _file = "${toString ./.}/flake.nix#flakeModule";
        imports = [
          ./flake-module.nix
          {jupyenv.flake = self;}
        ];
      };
      templates.default = self.templates.flake-utils;
      templates.flake-utils = {
        path = ./template/flake-utils;
        description = "Boilerplate for your jupyenv project";
        inherit welcomeText;
      };
      templates.flake-parts = {
        path = ./template/flake-parts;
        description = "Boilerplate for your jupyenv project";
        inherit welcomeText;
      };
    };
}