Merge pull request tweag#70 from freuk/master

[feature] adds a "extraJupyterPath" arguments for local python module development.

Author: guaraqe

README.md

@@ -198,7 +198,28 @@ let
   };
 ```
 
-Here, the `p` argument corresponds to Nixpkgs checkout being used.
+Here, the `p` argument corresponds to Nixpkgs checkout being used. Note that
+this can easily be made to use packages from outside `jupyterWith`'s scope, by
+providing a function that ignores its argument:
+
+```nix
+  extraPackages = _ : [ pkgs.pandoc ];
+```
+
+You may also bring all inputs from a package in scope using the
+"extraInputsFrom" argument:
+
+``` nix
+let
+  jupyter = import (builtins.fetchGit {
+    url = https://github.com/tweag/jupyterWith;
+    rev = "";
+  }) {};
+
+  jupyterEnvironment = jupyter.jupyterlabWith {
+    extraInputsFrom = p: [p.pythonPackages.numpy];
+  };
+```
 
 ## Using as an overlay
 
@@ -224,6 +245,24 @@ in
   pkgs.jupyterWith;
 ```
 
+## Importing local python packages
+
+You may use the `extraJupyterPath` arguments to add local
+python packages in scope:
+
+```
+let
+  jupyter = import (builtins.fetchGit {
+    url = https://github.com/tweag/jupyterWith;
+    rev = "";
+  }) {};
+
+  jupyterEnvironment = jupyter.jupyterlabWith {
+    extraJupyterPath = "${builtins.toPath ./.}/local_module/";
+  };
+```
+
+
 ## Contributing
 
 ### Kernels

default.nix

@@ -18,12 +18,15 @@ let
   defaultDirectory = "${python3.jupyterlab}/share/jupyter/lab";
   defaultKernels = [ (kernels.iPythonWith {}) ];
   defaultExtraPackages = p: [];
+  defaultExtraInputsFrom = p: [];
 
   # JupyterLab with the appropriate kernel and directory setup.
   jupyterlabWith = {
     directory ? defaultDirectory,
     kernels ? defaultKernels,
-    extraPackages ? defaultExtraPackages
+    extraPackages ? defaultExtraPackages,
+    extraInputsFrom ? defaultExtraInputsFrom,
+    extraJupyterPath ? ""
     }:
     let
       # PYTHONPATH setup for JupyterLab
@@ -39,15 +42,16 @@ let
         python3.jupyterlab.overridePythonAttrs (oldAttrs: {
           makeWrapperArgs = [
             "--set JUPYTERLAB_DIR ${directory}"
-            "--set JUPYTER_PATH ${kernelsString kernels}"
-            "--set PYTHONPATH ${pythonPath}"
+            "--set JUPYTER_PATH ${extraJupyterPath}:${kernelsString kernels}"
+            "--set PYTHONPATH ${extraJupyterPath}:${pythonPath}"
           ];
         })
       );
 
       # Shell with the appropriate JupyterLab, launching it at startup.
       env = pkgs.mkShell {
         name = "jupyterlab-shell";
+        inputsFrom = extraInputsFrom pkgs;
         buildInputs =
           [ jupyterlab generateDirectory pkgs.nodejs ] ++
           (map (k: k.runtimePackages) kernels) ++