Repolode
timkpaine

timkpaine/jupyterlab-commands

任意のPython関数をコマンドパレットに登録できるJupyterLab拡張機能。

スター
63
フォーク
7
未解決の Issue
1
最終コミット
6 日前

これは何?

jupyterlab-commandsを使うと、ユーザー定義のPython関数をJupyterLabのコマンドパレットに追加できます。各コマンドはJupyterLabサーバーの設定を通じて登録する小さなPython関数で、サーバー側で実行されるため、ノートブックのセルに記述する必要はありません。

ノートブックでの分析とは直接関係しない、繰り返し実行するタスクに便利です。たとえば、あらかじめ決めたnbconvertによるエクスポートや、バージョン管理操作を実行できます。コマンドの出力はJupyterLab内のターミナルに表示されるため、画面を離れずに結果を確認できます。

このプロジェクトはpipでインストールし、jupyter_lab_config.pyでJupyterLabCommandsクラスにコマンドの辞書を設定します。関連プロジェクトのjupyterlab-nbconvert-nocodeは、コードセルを除去してノートブックを変換します。

主な機能

  • 01カスタムPython関数をJupyterLabのコマンドパレットに追加できます。
  • 02ノートブックやコンソールの外で、サーバー側のコマンドを実行できます。
  • 03コマンドの出力をJupyterLabのターミナルに表示します。
  • 04jupyter_lab_config.pyでシンプルな辞書を使って設定できます。

ユースケース

  • ワンクリックでノートブックを所定の設定でnbconvertエクスポートする。
  • 操作をノートブックに記録せずに、バージョン管理のアクションを実行する。
  • チーム固有のヘルパースクリプトをコマンドパレットから実行できるようにする。

クイックスタート

  1. 1

    PyPIからパッケージをインストールする

    pip install jupyterlab-commands
  2. 2

    Pythonのコマンド関数をjupyter_lab_config.pyに追加し、c.JupyterLabCommands.commandsを設定する

使う前に知っておきたいこと

  • コマンドはJupyterの設定ファイル内でPython関数として定義するため、セットアップには設定ファイルの編集が必要です。

トピック

よくある質問

jupyterlab-commands とは?
任意のPython関数をコマンドパレットに登録できるJupyterLab拡張機能。 jupyterlab-commandsを使うと、ユーザー定義のPython関数をJupyterLabのコマンドパレットに追加できます。各コマンドはJupyterLabサーバーの設定を通じて登録する小さなPython関数で、サーバー側で実行されるため、ノートブックのセルに記述する必要はありません。
jupyterlab-commands は無料で使えますか?ライセンスは?
jupyterlab-commands は Apache-2.0 ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
jupyterlab-commands は今もメンテナンスされていますか?
活発にメンテナンス中。jupyterlab-commands の最終コミットは 2026年11月1日 です。
jupyterlab-commands は何に使えますか?
ワンクリックでノートブックを所定の設定でnbconvertエクスポートする。 操作をノートブックに記録せずに、バージョン管理のアクションを実行する。 チーム固有のヘルパースクリプトをコマンドパレットから実行できるようにする。
jupyterlab-commands のインストール方法は?
PyPIからパッケージをインストールする: pip install jupyterlab-commands Pythonのコマンド関数をjupyter_lab_config.pyに追加し、c.JupyterLabCommands.commandsを設定する
jupyterlab-commands はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/timkpaine/jupyterlab-commands

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト