nixos/jupyter: migrate service to jupyter 7 setup

[b-m-f]

The current implementation has problems after the jupyter project introduced changes: https://jupyter-notebook.readthedocs.io/en/latest/migrate_to_notebook7.html

This MR:

• changes the location of the config file for the password setting
• links to the official docs for hashed password generation
• uses jupyter notebook command
• allows adding extra packages to the jupyter runtime environment
• allows setting extra environment variables

The last 2 changes come with an example in order to add export to WebPDF.

Closes #355046

Things done

• Built on platform(s)
  • x86_64-linux
  • aarch64-linux
  • x86_64-darwin
  • aarch64-darwin
• For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
  • sandbox = relaxed
  • sandbox = true
• Tested, as applicable:
  • NixOS test(s) (look inside nixos/tests)
  • and/or package tests
  • or, for functions and "core" functionality, tests in lib/tests or pkgs/test
  • made sure NixOS tests are linked to the relevant packages
• Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
• Tested basic functionality of all binary files (usually in ./result/bin/)
• 25.05 Release Notes (or backporting 24.11 and 25.05 Release notes)
  • (Package updates) Added a release notes entry if the change is major or breaking
  • (Module updates) Added a release notes entry if the change is significant
  • (Module addition) Added a release notes entry if adding a new NixOS module
• Fits CONTRIBUTING.md.

---

Add a 👍 reaction to pull requests you find important.

[b-m-f]

@aborsu

[GaetanLepage]

Thanks for this.
Can you clean the commit history and prefix all commit messages with nixos/jupyter: ?

[b-m-f]

@GaetanLepage Updated. Thanks for the guidance

[GaetanLepage]

@GaetanLepage Updated. Thanks for the guidance

The current commit message is Updates jupyter notebook config to work correctly with current versions.
It should start with nixos/jupyter: .....

[b-m-f]

Updated 🫡

[JohnRTitor]

Blocked until the above comments are resolved

[JohnRTitor]

Please add a release notes too.

[b-m-f]

I’ll implement the changes either on the 31st or in the new year.
Thanks for the input

[b-m-f]

@JohnRTitor MR is updated

[b-m-f]

@JohnRTitor I have added the change into the release-notes. I hope that is the correct place. Notebook config is now included again.

changes addressed

[JohnRTitor]

Should be backported to 24.11 as notebook 7 exists there too. Please add a release-notes for 24.11 as well.

Diff LGTM, will merge after testing.

[JohnRTitor]

Did some minor nitpicks.

And tested the module like this JohnRTitor/nix-conf@b6c504a

Lets me login now (with a previously generated password). But when I tried to generate a new one it showed an error. Could you investigate?

I am using a pretty basic config. https://github.com/JohnRTitor/nix-conf/blob/b6c504ab5ad36af2e4e0191fa4ca9fa67e04efa4/dev-environment/jupyter.nix

The above code snippet works if I use the server from

nix-shell -p 'python3.withPackages (ps: with ps; [jupyter])' --run 'jupyter notebook'

[b-m-f]

@JohnRTitor Thanks for the attention to detail!

As for the error with password generation it looks like expected behaviour to me.

The code in the notebook will run within its own execution environment, the kernel, this is isolated from the execution environment that the server itself runs within. https://docs.jupyter.org/en/latest/projects/kernels.html

jupyter-server is not included there by default.

You could try the following kernel to get it to work:

    kernels = {
      jupyter =
        let
          env = (
            pkgs.python3.withPackages (
              ps: with ps; [
                ipykernel
                jupyter
              ]
            )
          );
        in
        {
          displayName = "Python 3 jupyter env";
          argv = [
            "${env.interpreter}"
            "-m"
            "ipykernel_launcher"
            "-f"
            "{connection_file}"
          ];
          language = "python";
          extraPaths = {
            "cool.txt" = pkgs.writeText "cool" "cool content";
          };
        };
    };

When the kernel is set up this way it will be selectable in the UI.

[JohnRTitor]

Nice, thanks.

Let me just rebase so we remove the merge conflict here.

[nix-backports]

Backport failed for release-24.11, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin release-24.11
git worktree add -d .worktree/backport-367106-to-release-24.11 origin/release-24.11
cd .worktree/backport-367106-to-release-24.11
git switch --create backport-367106-to-release-24.11
git cherry-pick -x f199d57ad67ebebf001f50db0f6f823ad1cf0835