Skip to content

Latest commit

 

History

History
66 lines (39 loc) · 1.85 KB

kernelspec.rst

File metadata and controls

66 lines (39 loc) · 1.85 KB

kernelspec - discovering kernels

kernelspecs

jupyter_client.kernelspec

argv

The list of arguments to start this kernel.

env

A dictionary of extra environment variables to declare, in addition to the current environment variables, when launching this kernel.

display_name

The name to display for this kernel in UI.

language

The name of the language the kernel implements, to help with picking appropriate kernels when loading notebooks.

metadata

Additional kernel-specific metadata; clients can use this as needed, for instance to aid in kernel selection and filtering.

Metadata added here should be namespaced for the tool reading and writing that metadata. Concretely, if you're adding a new field called supported_versions which your tool recognizes, then you should add it as "mytool": {"supported_versions": [1, 2]}, not as a top-level field called supported_versions.

resource_dir

The path to the directory with this kernel's resources, such as icons.

to_json

find_kernel_specs

get_all_specs

get_kernel_spec

install_kernel_spec

NoSuchKernel

name

The name of the kernel which was requested.

find_kernel_specs get_kernel_spec(kernel_name) install_kernel_spec(source_dir, kernel_name=None, user=False, replace=False)

These methods from KernelSpecManager are exposed as functions on the module as well; they will use all the default settings.