AnswerDotAI/nbdev

これは何？

主な機能

• 01ノートブックをPythonモジュールにエクスポートし、ソースコードと双方向に同期
• 02QuartoとGitHub Pagesを使って、検索可能なドキュメントサイトを生成
• 03ノートブックベースのテストを1つのコマンドで並列実行
• 04CIとドキュメントの再ビルドに対応したGitHub Actionsワークフローを提供
• 05パッケージをPyPIとcondaに公開
• 06ノートブックを整理し、マージコンフリクトを解決するGit hooksを搭載

ユースケース

• コード、テスト、ドキュメントをノートブックにまとめたPythonライブラリの開発
• 自動リリースを利用した、オープンソースPythonパッケージのPyPIへの公開
• ソースコードからドキュメントを生成し、ハイパーリンクで結び付けた状態の維持
• ノートブックを同期したまま、IDEでノートブックベースのコードを編集

クイックスタート

1. 1

   pipでnbdevをインストールする

   pip install nbdev
2. 2

   nbdev-helpを実行して、利用可能なコマンドを確認する

   nbdev-help

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

• !WindowsではWSLが必要です。cmdやPowerShellでは動作しません。
• !Jupyterとプロジェクトで使用するものと同じPython環境にインストールする必要があります。
• !2026年1月のnbdev3リリースでは設定先がpyproject.tomlに変更されました。これはnbdev2プロジェクトとの互換性を損なう変更です。

収録されている特集

トピック

よくある質問

nbdev とは？

Jupyter Notebookからドキュメント、テスト、CI、PyPI/condaへのリリースに対応したPythonパッケージを作成する、ノートブック主導の開発プラットフォーム。 nbdevを使うと、軽量なマークアップを使ってJupyter Notebook上でPythonコード、テスト、ドキュメントを記述できます。ノートブックからPythonモジュールをエクスポートし、QuartoとGitHub Pagesでドキュメントサイトを生成し、テストを並列実行できます。また、継続的インテグレーション用のGitHub Actionsも設定できます。

nbdev は無料で使えますか？ライセンスは？

nbdev は Apache-2.0 ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

nbdev は今もメンテナンスされていますか？

活発にメンテナンス中。nbdev の最終コミットは 2026年11月5日 です。

nbdev は何に使えますか？

コード、テスト、ドキュメントをノートブックにまとめたPythonライブラリの開発 自動リリースを利用した、オープンソースPythonパッケージのPyPIへの公開 ソースコードからドキュメントを生成し、ハイパーリンクで結び付けた状態の維持 ノートブックを同期したまま、IDEでノートブックベースのコードを編集

nbdev のインストール方法は？

pipでnbdevをインストールする: pip install nbdev nbdev-helpを実行して、利用可能なコマンドを確認する: nbdev-help

nbdev はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/AnswerDotAI/nbdev