uvを使って、JupyterをVSCodeで使いたい
はじめに
最近、uv というものを入れました。
ただ、Jupyter を VSCode で使うのに少し手間取ったので手順を簡単にまとめました。
皆さんの参考になれば幸いです。
uv のインストール
macOS と Linux
使用している OS が macOS と Linux の場合、以下のコマンドでインストールできます。
curl -LsSf https://astral.sh/uv/install.sh | sh
Windows
使用している OS が Windows の場合、以下のコマンドでインストールできます。
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
uv に Jupyter を追加
以下のコマンドで、uv に jupyter と ipykernel を入れることができます。
--dev の有無による違いは調べた感じですと、こんな感じらしいです。
---dev 無し |
---dev 有り |
|
|---|---|---|
| 追加したパッケージ | 本番依存に入る | 開発依存に入る |
| 詳細 | アプリの動作に必須のライブラリを入れる | テストや開発のときだけ必要なライブラリを入れる / 本番環境にデプロイするときはインストールされない |
uv add --dev jupyter ipykernel
Kernel を登録
ChatGPT にこんな風に言われたので、カーネルを作ります。
そのままだと VSCode がカーネルを認識しない場合があるので、明示的にカーネルを作っておくと安心です
uv run python -m ipykernel install --user --name=<カーネル識別子> --display-name "カーネル名"
各オプション
--user
カーネルを「ユーザー環境」にインストールするオプション。
基本的に、固定で --user を付ければ大丈夫そうです。
--name
Jupyter 内部で使われる「カーネル識別子」。
ロジェクトや環境ごとにユニークな名前を付ける必要があります。
--display-name
VSCode や Jupyter の UI に表示されるカーネル名。
分かりやすく書けば大丈夫です。
VSCode 上で、カーネルを選択
カーネルを選択する場所を選択。
先ほどの --display-name で指定したものを選択すれば、それを選択すれば環境構築は成功です。
私の場合、--display-name で指定したものが表示されませんでしたが、アプリの再起動で表示されるようになりました。
動作確認
Jupyter 上で、以下を実行してください。
!which python
結果が、プロジェクトが以下のパスなら成功です。
<プロジェクトの絶対パス>/.venv/bin/python
おわりに
この記事が皆さんの参考になれば何よりです。