Install Python package inside a Jupyter Notebook kernel

Question

Inside a Jupyter Notebook I have managed to install a Python kernel with

!python -m ipykernel install --user --name other-env --display-name "Python (other-env)"

as informed here and it is available with other kernels on the menu Kernel → Change kernel and

!jupyter kernelspec list

will also show them

Available kernels:
  avenv         C:\Users\Full Name\AppData\Roaming\jupyter\kernels\avenv
  chatterbot    C:\Users\Full Name\AppData\Roaming\jupyter\kernels\chatterbot
  othervenv     C:\Users\Full Name\AppData\Roaming\jupyter\kernels\othervenv
  python3       C:\Users\Full Name\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.10_qbz5n2kfra8p0\LocalCache\local-packages\share\jupyter\kernels\python3

Then I try to install Python a package using

%pip install a_package

as given here that said

with % (instead of !) it will install a_package into the current kernel (rather than into the instance of Python that launched the notebook).

But what I have got that it installs a_package to all kernels, or %pip list will list the same installed packages in all kernels.

Is there a way to install Python package only to an active Jupyter Notebook kernel?

score 1 · Answer 1 · answered Feb 09 '23 at 20:24

1

Here is what I have used to overcome this issue

import sys
!{sys.executable} -m pip install a_package

answered Feb 09 '23 at 20:24

user13374981

11
1

Will that install the `a_package` globally or only in active Jupyter kernel, @user13374981? – dudung Feb 10 '23 at 00:21

score 1 · Accepted Answer · answered Feb 12 '23 at 00:15

Short answer

Path of python executable in JSON file of Jupyter kernel should point to python executable in related virtual environment.

Long answer

After some tries the steps can be summarized as follow.

Python virtual environment

Create Python virtual environment from a shell, e.g. PowerShell, as in here, in a folder (in this case it is c:\venvs\butiran)

PS C:\> python -m venv c:\venvs\butiran

Change directory to the folder, e.g in this case is butiran in venvs (folder for all virtual environments)

PS C:\> cd venvs\butiran
PS C:\venvs\butiran>

Activate virtual environment as in here

PS C:\venvs\butiran> Scripts\activate
(butiran) PS C:\venvs\butiran>

Update pip as in here

(butiran) PS C:\venvs\butiran> python -m pip install --upgrade pip

Install ipykernel as in here

(butiran) PS C:\venvs\butiran> pip install ipykernel

Deactivate virtual enviroment in powershell as in here

(butiran) PS C:\venvs\butiran> deactivate
PS C:\venvs\butiran>

Jupyter kernel

Install ipykernel for Jupyter Notebook as in here

PS C:\venvs\butiran> python -m ipykernel install --user --name butiran --display-name "Python (butiran)"
Installed kernelspec butiran in C:\Users\Full Name\AppData\Roaming\jupyter\kernels\butiran
PS C:\venvs\butiran>

Show JSON file of installed kernel

PS C:\venvs\butiran> cat "C:\Users\Full Name\AppData\Roaming\jupyter\kernels\butiran\kernel.json"
{
 "argv": [
  "C:\\Users\\Full Name\\AppData\\Local\\Microsoft\\WindowsApps\\PythonSoftwareFoundation.Python.3.10_qbz5n2kfra8p0\\python.exe",
  "-m",
  "ipykernel_launcher",
  "-f",
  "{connection_file}"
 ],
 "display_name": "Python (butiran)",
 "language": "python",
 "metadata": {
  "debugger": true
 }
}
PS C:\venvs\butiran>

Change path to python.exe

from C:\\Users\\Full Name\\AppData\\Local\\Microsoft\\WindowsApps\\PythonSoftwareFoundation.Python.3.10_qbz5n2kfra8p0\\python.exe
to C:\\venvs\\butiran\\Scripts\\python.exe

Jupyter Notebook

Lanuch Jupyter Notebook from PowerShell

PS C:\> jupyter notebook

Open existing notebook or create a new one.
Change kernel from menu Kernel → Change kernel → Python (butiran).
Install a_package using only in active kernel

%pip install a_package

or with

import sys
!{sys.executable} -m pip install a_package

Show the package globally

!pip show a_package

will give

WARNING: Package(s) not found: a_package

while show the package in active kernel

%pip show a_package