commit 4d3ce5ca36a145748a4938cb0127c115d8fbacf0 · pyrox.dev/nixpkgs

nixos/modules/module-list.nix

···

       250
       250
        
         ./services/desktops/zeitgeist.nix

     

       251
       251
        
         ./services/development/bloop.nix

     

       252
       252
        
         ./services/development/hoogle.nix

     

       253
       253
       +
         ./services/development/jupyter/default.nix

     

       253
       254
        
         ./services/editors/emacs.nix

     

       254
       255
        
         ./services/editors/infinoted.nix

     

       255
       256
        
         ./services/games/factorio.nix

+184

nixos/modules/services/development/jupyter/default.nix

···

       1
       1
       +
       { config, lib, pkgs, ... }:

     

       2
       2
       +
       

     

       3
       3
       +
       with lib;

     

       4
       4
       +
       

     

       5
       5
       +
       let

     

       6
       6
       +
       

     

       7
       7
       +
         cfg = config.services.jupyter;

     

       8
       8
       +
       

     

       9
       9
       +
         # NOTE: We don't use top-level jupyter because we don't

     

       10
       10
       +
         # want to pass in JUPYTER_PATH but use .environment instead,

     

       11
       11
       +
         # saving a rebuild.

     

       12
       12
       +
         package = pkgs.python3.pkgs.notebook;

     

       13
       13
       +
       

     

       14
       14
       +
         kernels = (pkgs.jupyter-kernel.create  {

     

       15
       15
       +
           definitions = if cfg.kernels != null

     

       16
       16
       +
             then cfg.kernels

     

       17
       17
       +
             else  pkgs.jupyter-kernel.default;

     

       18
       18
       +
         });

     

       19
       19
       +
       

     

       20
       20
       +
         notebookConfig = pkgs.writeText "jupyter_config.py" ''

     

       21
       21
       +
           ${cfg.notebookConfig}

     

       22
       22
       +
       

     

       23
       23
       +
           c.NotebookApp.password = ${cfg.password}

     

       24
       24
       +
         '';

     

       25
       25
       +
       

     

       26
       26
       +
       in {

     

       27
       27
       +
         meta.maintainers = with maintainers; [ aborsu ];

     

       28
       28
       +
       

     

       29
       29
       +
         options.services.jupyter = {

     

       30
       30
       +
           enable = mkEnableOption "Jupyter development server";

     

       31
       31
       +
       

     

       32
       32
       +
           ip = mkOption {

     

       33
       33
       +
             type = types.str;

     

       34
       34
       +
             default = "localhost";

     

       35
       35
       +
             description = ''

     

       36
       36
       +
               IP address Jupyter will be listening on.

     

       37
       37
       +
             '';

     

       38
       38
       +
           };

     

       39
       39
       +
       

     

       40
       40
       +
           port = mkOption {

     

       41
       41
       +
             type = types.int;

     

       42
       42
       +
             default = 8888;

     

       43
       43
       +
             description = ''

     

       44
       44
       +
               Port number Jupyter will be listening on.

     

       45
       45
       +
             '';

     

       46
       46
       +
           };

     

       47
       47
       +
       

     

       48
       48
       +
           notebookDir = mkOption {

     

       49
       49
       +
             type = types.str;

     

       50
       50
       +
             default = "~/";

     

       51
       51
       +
             description = ''

     

       52
       52
       +
               Root directory for notebooks.

     

       53
       53
       +
             '';

     

       54
       54
       +
           };

     

       55
       55
       +
       

     

       56
       56
       +
           user = mkOption {

     

       57
       57
       +
             type = types.str;

     

       58
       58
       +
             default = "jupyter";

     

       59
       59
       +
             description = ''

     

       60
       60
       +
               Name of the user used to run the jupyter service.

     

       61
       61
       +
               For security reason, jupyter should really not be run as root.

     

       62
       62
       +
               If not set (jupyter), the service will create a jupyter user with appropriate settings.

     

       63
       63
       +
             '';

     

       64
       64
       +
             example = "aborsu";

     

       65
       65
       +
           };

     

       66
       66
       +
       

     

       67
       67
       +
           group = mkOption {

     

       68
       68
       +
             type = types.str;

     

       69
       69
       +
             default = "jupyter";

     

       70
       70
       +
             description = ''

     

       71
       71
       +
               Name of the group used to run the jupyter service.

     

       72
       72
       +
               Use this if you want to create a group of users that are able to view the notebook directory's content.

     

       73
       73
       +
             '';

     

       74
       74
       +
             example = "users";

     

       75
       75
       +
           };

     

       76
       76
       +
       

     

       77
       77
       +
           password = mkOption {

     

       78
       78
       +
             type = types.str;

     

       79
       79
       +
             description = ''

     

       80
       80
       +
               Password to use with notebook.

     

       81
       81
       +
               Can be generated using:

     

       82
       82
       +
                 In [1]: from notebook.auth import passwd

     

       83
       83
       +
                 In [2]: passwd('test')

     

       84
       84
       +
                 Out[2]: 'sha1:1b961dc713fb:88483270a63e57d18d43cf337e629539de1436ba'

     

       85
       85
       +
                 NOTE: you need to keep the single quote inside the nix string.

     

       86
       86
       +
               Or you can use a python oneliner:

     

       87
       87
       +
                 "open('/path/secret_file', 'r', encoding='utf8').read().strip()"

     

       88
       88
       +
               It will be interpreted at the end of the notebookConfig.

     

       89
       89
       +
             '';

     

       90
       90
       +
             example = [

     

       91
       91
       +
               "'sha1:1b961dc713fb:88483270a63e57d18d43cf337e629539de1436ba'"

     

       92
       92
       +
               "open('/path/secret_file', 'r', encoding='utf8').read().strip()"

     

       93
       93
       +
             ];

     

       94
       94
       +
           };

     

       95
       95
       +
       

     

       96
       96
       +
           notebookConfig = mkOption {

     

       97
       97
       +
             type = types.lines;

     

       98
       98
       +
             default = "";

     

       99
       99
       +
             description = ''

     

       100
       100
       +
               Raw jupyter config.

     

       101
       101
       +
             '';

     

       102
       102
       +
           };

     

       103
       103
       +
       

     

       104
       104
       +
           kernels = mkOption {

     

       105
       105
       +
             type = types.nullOr (types.attrsOf(types.submodule (import ./kernel-options.nix {

     

       106
       106
       +
               inherit lib;

     

       107
       107
       +
             })));

     

       108
       108
       +
       

     

       109
       109
       +
             default = null;

     

       110
       110
       +
             example = literalExample ''

     

       111
       111
       +
               {

     

       112
       112
       +
                 python3 = let

     

       113
       113
       +
                   env = (pkgs.python3.withPackages (pythonPackages: with pythonPackages; [

     

       114
       114
       +
                           ipykernel

     

       115
       115
       +
                           pandas

     

       116
       116
       +
                           scikitlearn

     

       117
       117
       +
                         ]));

     

       118
       118
       +
                 in {

     

       119
       119
       +
                   displayName = "Python 3 for machine learning";

     

       120
       120
       +
                   argv = [

     

       121
       121
       +
                     "$ {env.interpreter}"

     

       122
       122
       +
                     "-m"

     

       123
       123
       +
                     "ipykernel_launcher"

     

       124
       124
       +
                     "-f"

     

       125
       125
       +
                     "{connection_file}"

     

       126
       126
       +
                   ];

     

       127
       127
       +
                   language = "python";

     

       128
       128
       +
                   logo32 = "$ {env.sitePackages}/ipykernel/resources/logo-32x32.png";

     

       129
       129
       +
                   logo64 = "$ {env.sitePackages}/ipykernel/resources/logo-64x64.png";

     

       130
       130
       +
                 };

     

       131
       131
       +
               }

     

       132
       132
       +
             '';

     

       133
       133
       +
             description = "Declarative kernel config

     

       134
       134
       +
       

     

       135
       135
       +
             Kernels can be declared in any language that supports and has the required

     

       136
       136
       +
             dependencies to communicate with a jupyter server.

     

       137
       137
       +
             In python's case, it means that ipykernel package must always be included in

     

       138
       138
       +
             the list of packages of the targeted environment.

     

       139
       139
       +
             ";

     

       140
       140
       +
           };

     

       141
       141
       +
         };

     

       142
       142
       +
       

     

       143
       143
       +
         config = mkMerge [

     

       144
       144
       +
           (mkIf cfg.enable  {

     

       145
       145
       +
             systemd.services.jupyter = {

     

       146
       146
       +
               description = "Jupyter development server";

     

       147
       147
       +
       

     

       148
       148
       +
               wantedBy = [ "multi-user.target" ];

     

       149
       149
       +
       

     

       150
       150
       +
               # TODO: Patch notebook so we can explicitly pass in a shell

     

       151
       151
       +
               path = [ pkgs.bash ]; # needed for sh in cell magic to work

     

       152
       152
       +
       

     

       153
       153
       +
               environment = {

     

       154
       154
       +
                 JUPYTER_PATH = toString kernels;

     

       155
       155
       +
               };

     

       156
       156
       +
       

     

       157
       157
       +
               serviceConfig = {

     

       158
       158
       +
                 Restart = "always";

     

       159
       159
       +
                 ExecStart = ''${package}/bin/jupyter-notebook \

     

       160
       160
       +
                   --no-browser \

     

       161
       161
       +
                   --ip=${cfg.ip} \

     

       162
       162
       +
                   --port=${toString cfg.port} --port-retries 0 \

     

       163
       163
       +
                   --notebook-dir=${cfg.notebookDir} \

     

       164
       164
       +
                   --NotebookApp.config_file=${notebookConfig}

     

       165
       165
       +
                 '';

     

       166
       166
       +
                 User = cfg.user;

     

       167
       167
       +
                 Group = cfg.group;

     

       168
       168
       +
                 WorkingDirectory = "~";

     

       169
       169
       +
               };

     

       170
       170
       +
             };

     

       171
       171
       +
           })

     

       172
       172
       +
           (mkIf (cfg.enable && (cfg.group == "jupyter")) {

     

       173
       173
       +
             users.groups.jupyter = {};

     

       174
       174
       +
           })

     

       175
       175
       +
           (mkIf (cfg.enable && (cfg.user == "jupyter")) {

     

       176
       176
       +
             users.extraUsers.jupyter = {

     

       177
       177
       +
               extraGroups = [ cfg.group ];

     

       178
       178
       +
               home = "/var/lib/jupyter";

     

       179
       179
       +
               createHome = true;

     

       180
       180
       +
               useDefaultShell = true; # needed so that the user can start a terminal.

     

       181
       181
       +
             };

     

       182
       182
       +
           })

     

       183
       183
       +
         ];

     

       184
       184
       +
       }

+60

nixos/modules/services/development/jupyter/kernel-options.nix

···

       1
       1
       +
       # Options that can be used for creating a jupyter kernel.

     

       2
       2
       +
       {lib }:

     

       3
       3
       +
       

     

       4
       4
       +
       with lib;

     

       5
       5
       +
       

     

       6
       6
       +
       {

     

       7
       7
       +
         options = {

     

       8
       8
       +
       

     

       9
       9
       +
           displayName = mkOption {

     

       10
       10
       +
             type = types.str;

     

       11
       11
       +
             default = "";

     

       12
       12
       +
             example = [

     

       13
       13
       +
               "Python 3"

     

       14
       14
       +
               "Python 3 for Data Science"

     

       15
       15
       +
             ];

     

       16
       16
       +
             description = ''

     

       17
       17
       +
               Name that will be shown to the user.

     

       18
       18
       +
             '';

     

       19
       19
       +
           };

     

       20
       20
       +
       

     

       21
       21
       +
           argv = mkOption {

     

       22
       22
       +
             type = types.listOf types.str;

     

       23
       23
       +
             example = [

     

       24
       24
       +
               "{customEnv.interpreter}"

     

       25
       25
       +
               "-m"

     

       26
       26
       +
               "ipykernel_launcher"

     

       27
       27
       +
               "-f"

     

       28
       28
       +
               "{connection_file}"

     

       29
       29
       +
             ];

     

       30
       30
       +
             description = ''

     

       31
       31
       +
               Command and arguments to start the kernel.

     

       32
       32
       +
             '';

     

       33
       33
       +
           };

     

       34
       34
       +
       

     

       35
       35
       +
           language = mkOption {

     

       36
       36
       +
             type = types.str;

     

       37
       37
       +
             example = "python";

     

       38
       38
       +
             description = ''

     

       39
       39
       +
               Language of the environment. Typically the name of the binary.

     

       40
       40
       +
             '';

     

       41
       41
       +
           };

     

       42
       42
       +
       

     

       43
       43
       +
           logo32 = mkOption {

     

       44
       44
       +
             type = types.nullOr types.path;

     

       45
       45
       +
             default = null;

     

       46
       46
       +
             example = "{env.sitePackages}/ipykernel/resources/logo-32x32.png";

     

       47
       47
       +
             description = ''

     

       48
       48
       +
               Path to 32x32 logo png.

     

       49
       49
       +
             '';

     

       50
       50
       +
           };

     

       51
       51
       +
           logo64 = mkOption {

     

       52
       52
       +
             type = types.nullOr types.path;

     

       53
       53
       +
             default = null;

     

       54
       54
       +
             example = "{env.sitePackages}/ipykernel/resources/logo-64x64.png";

     

       55
       55
       +
             description = ''

     

       56
       56
       +
               Path to 64x64 logo png.

     

       57
       57
       +
             '';

     

       58
       58
       +
           };

     

       59
       59
       +
         };

     

       60
       60
       +
       }