PythonAdvent Calendar 2024

Visual Studio Codeにより起動したJupyter Notebookからuvで作成したカーネルを選択する手順

Posted at 2024-12-17

概要

「Visual Studio Code（VS Code）により起動したJupyter Notebook（ノートブック）からuvで作成したカーネルを選択する手順」を紹介します。

uvの使用が可能な状態にしてください。

uv --version

uv 0.5.6

プロジェクト自体を作成しご自身の開発環境に導入する場合は、以下の手順を実行してください。

共同作業など共有を受けたプロジェクトに対してご自身の開発環境に導入する場合は、以下の手順を実行してください。

上記のいずれかの手順を終えた上で改めてVS Codeにてノートブックを起動させる場合は、以下の手順を実行してください。

新規にuvで管理するプロジェクトを作成する場合は、以下のコマンドを実行してください。project-nameには任意の名前を指定してください。

uv init project-name

以下が作成されます。

project-name
├── .python-version
├── README.md
├── hello.py
└── pyproject.toml

既存のプロジェクトにuvを導入する場合は、プロジェクト直下で以下のコマンドを実行してください。

uv init --no-workspace

プロジェクトとなるディレクトリの直下に対象のipynbファイル（例：example.ipynb）が配置されている状態にしてください。任意ですが、hello.pyは削除します。

project-name
├── .python-version
├── README.md
├── example.ipynb
└── pyproject.toml

そして、uvによって対象となるノートブックの実行に必要なパッケージをインストールしてください。

uv.lockが作成されます。

project-name
├── .python-version
├── README.md
├── example.ipynb
├── pyproject.toml
└── uv.lock

以下のコマンドにより仮想環境を作成してください。

uv venv

すると.venvという名称の仮想環境が作成されます。

Using CPython 3.13.0
Creating virtual environment at: .venv
Activate with: source .venv/bin/activate

後述する「②仮想環境の使用」においてはsource .venv/bin/activateというコマンドを使います。

仮想環境の名前を指定する場合は以下を実行してください。venv-nameには任意の名前を指定してください。

uv venv venv-name

するとvenv-nameという名称の仮想環境が作成されます。

Using CPython 3.13.0
Creating virtual environment at: venv-name
Activate with: source venv-name/bin/activate

後述する「②仮想環境の使用」においてはsource venv-name/bin/activateというコマンドを使います。

仮想環境の作成によって出力されたActivate with: 以降のコマンドを実行し、仮想環境を使用してください。

source .venv/bin/activate

source venv-name/bin/activate

以降で仮想環境の使用を止める際は、以下のコマンドを実行してください。

deactivate

以下のコマンドによりipykernelをインストールしてください。

uv pip install ipykernel

以下のコマンドによりカーネルを作成してください。kernel-nameには任意の名前を指定してください。個人的にはプロジェクトの名前を指定します。

ipython kernel install --user --name=kernel-name

VS Codeによりノートブックのカーネルとして、ここまでで作成したカーネルを選択します。

これにより、VS Codeにより起動したノートブックからuvで作成したカーネルを選択することができます。

以降、状況にもよりますがVS Codeによりノートブックを起動した時点でデフォルトのカーネルとして指定されることがあります。

手順は以上となります。

以下の手順については共同作業を円滑にする目的でREADME.mdに記述することをおすすめします。

記事に改善の余地がある場合は、編集リクエストを送っていただくか、コメントを投稿していただけますと幸いです。