Skip to content

(NEW) Options

kernel.python

IPython Kernel for Jupyter.

Type: attribute set of (submodule)

Default

{}

Example

"{\n  kernel.python.\"science\".enable = true;\n}\n"

kernel.python.<name>.displayName

Display name of the python kernel.

Type: string

Default

"Python python-‹name› kernel"

Example

"Python science kernel"

kernel.python.<name>.editablePackageSources

A mapping from package name to source directory, these will be installed in editable mode. Note that path dependencies with develop = true will be installed in editable mode unless explicitly passed to editablePackageSources as null.

Type: attribute set of (null or path)

Default

{}

Example

"{}"

kernel.python.<name>.enable

Enable python kernel.

Type: boolean

Default

false

Example

true

kernel.python.<name>.extraPackages

A function taking a Python package set and returning a list of extra packages to include in the environment. This is intended for packages deliberately not added to pyproject.toml that you still want to include. An example of such a package may be pip.

Type: function that evaluates to a(n) list of package

Default

"<function>"

Example

"ps: []"

kernel.python.<name>.groups

Which Poetry 1.2.0+ dependency groups to install for this python kernel.

Type: list of string

Default

["dev"]

Example

"[\"dev\" \"doc\"]"

kernel.python.<name>.name

Name of the python kernel.

Type: string

Default

"python-‹name›"

Example

"science"

kernel.python.<name>.nixpkgs

nixpkgs flake input to be used for this python kernel.

Type: package

Default

"/nix/store/n0f21zpy9w90sa9v75iwx6fmk897z3nw-source"

Example

"self.inputs.nixpkgs\n"

kernel.python.<name>.overrides

Path to overrides.nix file which provides python package overrides for this python kernel.

Type: path

Default

"/nix/store/364iaddzk3a1pd7adcmk1c67pv3mvaar-overrides.nix"

Example

"./overrides.nix"

kernel.python.<name>.poetry2nix

poetry2nix flake input to be used for this python kernel.

Type: package

Default

"/nix/store/4myxpy1b0lipw5mcrvvghj99n1b89a49-source"

Example

"self.inputs.poetry2nix\n"

kernel.python.<name>.poetrylock

Path to poetry.lock of the poetry project that provides this python kernel.

Type: path

Default

"/nix/store/a9kmzxx7j5cjdvr9vnfhk9076yvp4xax-source/kernels/available/python/poetry.lock"

Example

"projectDir + \"/poetry.lock\""

kernel.python.<name>.preferWheels

Use wheels rather than sdist as much as possible.

Type: boolean

Default

false

Example

"true"

kernel.python.<name>.projectDir

Path to the root of the poetry project that provides this python kernel.

Type: path

Default

"/nix/store/a9kmzxx7j5cjdvr9vnfhk9076yvp4xax-source/kernels/available/python"

Example

"self + \"/kernels/available/python\";"

kernel.python.<name>.pyproject

Path to pyproject.toml of the poetry project that provides this python kernel.

Type: path

Default

"/nix/store/a9kmzxx7j5cjdvr9vnfhk9076yvp4xax-source/kernels/available/python/pyproject.toml"

Example

"projectDir + \"/pyproject.toml\""

kernel.python.<name>.python

Name of the python interpreter (from nixpkgs) to be used for this python kernel.

Type: string

Default

"python3"

Example

"python310"

kernel.python.<name>.runtimePackages

A list of runtime packages available in this python kernel.

Type: list of package

Default

[]

kernel.python.<name>.withDefaultOverrides

Should we use default overrides provided by poetry2nix.

Type: boolean

Default

true

Example

"false"

runtimePackages

A list of runtime packages available to all binaries

Type: list of package

Default

[]