nixpkgs/nixos/modules/services/development/jupyter/kernel-options.nix
2018-08-26 12:00:54 +02:00

60 lines
1.3 KiB
Nix

# Options that can be used for creating a jupyter kernel.
{lib }:
with lib;
{
options = {
displayName = mkOption {
type = types.str;
default = "";
example = [
"Python 3"
"Python 3 for Data Science"
];
description = ''
Name that will be shown to the user.
'';
};
argv = mkOption {
type = types.listOf types.str;
example = [
"{customEnv.interpreter}"
"-m"
"ipykernel_launcher"
"-f"
"{connection_file}"
];
description = ''
Command and arguments to start the kernel.
'';
};
language = mkOption {
type = types.str;
example = "python";
description = ''
Language of the environment. Typically the name of the binary.
'';
};
logo32 = mkOption {
type = types.nullOr types.path;
default = null;
example = "{env.sitePackages}/ipykernel/resources/logo-32x32.png";
description = ''
Path to 32x32 logo png.
'';
};
logo64 = mkOption {
type = types.nullOr types.path;
default = null;
example = "{env.sitePackages}/ipykernel/resources/logo-64x64.png";
description = ''
Path to 64x64 logo png.
'';
};
};
}