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

   1 # Options that can be used for creating a jupyter kernel.
   2 {lib }:
   3
   4 with lib;
   5
   6 {
   7   options = {
   8
   9     displayName = mkOption {
  10       type = types.str;
  11       default = "";
  12       example = literalExpression ''
  13         "Python 3"
  14         "Python 3 for Data Science"
  15       '';
  16       description = lib.mdDoc ''
  17         Name that will be shown to the user.
  18       '';
  19     };
  20
  21     argv = mkOption {
  22       type = types.listOf types.str;
  23       example = [
  24         "{customEnv.interpreter}"
  25         "-m"
  26         "ipykernel_launcher"
  27         "-f"
  28         "{connection_file}"
  29       ];
  30       description = lib.mdDoc ''
  31         Command and arguments to start the kernel.
  32       '';
  33     };
  34
  35     language = mkOption {
  36       type = types.str;
  37       example = "python";
  38       description = lib.mdDoc ''
  39         Language of the environment. Typically the name of the binary.
  40       '';
  41     };
  42
  43     logo32 = mkOption {
  44       type = types.nullOr types.path;
  45       default = null;
  46       example = literalExpression ''"''${env.sitePackages}/ipykernel/resources/logo-32x32.png"'';
  47       description = lib.mdDoc ''
  48         Path to 32x32 logo png.
  49       '';
  50     };
  51     logo64 = mkOption {
  52       type = types.nullOr types.path;
  53       default = null;
  54       example = literalExpression ''"''${env.sitePackages}/ipykernel/resources/logo-64x64.png"'';
  55       description = lib.mdDoc ''
  56         Path to 64x64 logo png.
  57       '';
  58     };
  59
  60     extraPaths = mkOption {
  61       type = types.attrsOf types.path;
  62       default = { };
  63       example = literalExpression ''"{ examples = ''${env.sitePack}/IRkernel/kernelspec/kernel.js"; }'';
  64       description = lib.mdDoc ''
  65         Extra paths to link in kernel directory
  66       '';
  67     };
  68   };
  69 }