Repolode
jupytext

jupytext/jupytext

Jupyter notebookをプレーンなMarkdownやPython、Julia、Rのスクリプトとして保存し、Gitで差分を確認しやすく、きれいにバージョン管理できます。

スター
7,280
フォーク
437
未解決の Issue
164
最終コミット
3 日前

これは何?

Jupytextは、Jupyter notebookをプレーンテキスト形式に変換したり、テキスト形式から戻したりできます。notebookはMarkdown文書やPython、Julia、Rのスクリプトとして保存でき、入力セルと任意のメタデータだけを保持します。生成されたファイルはJupyterLabで通常のnotebookとして開けるほか、任意のテキストエディタやIDEで編集できます。

主な使い方はペアリングです。notebookを.ipynbファイルとテキストファイルの両方で保存し、2つの内容を同期します。チームはテキスト版をGitにコミットして読みやすい差分を確認しつつ、出力はローカルの.ipynbファイルに残せます。ペアリングはJupyterLabのコマンドパレット、ディレクトリ全体に適用する設定ファイル、または--syncや--toなどのコマンドを使ったコマンドラインから設定できます。

Jupytextは、コード中心のnotebook向けのpercentスクリプト形式に加え、MyST、Quarto、Pandocなど複数のMarkdown形式や、多くのプログラミング言語に対応しています。

主な機能

  • 01notebookをMarkdownやスクリプトファイルとして保存し、Gitで差分を確認しやすくします。
  • 02.ipynbファイルとテキスト版をペアにして、内容を同期します。
  • 03右クリックで開く操作や、ペアリング用のコマンドパレットからJupyterLabで利用できます。
  • 04notebookの変換や同期、リンターへのパイプ処理に使えるコマンドラインツールを提供します。
  • 05Python、Julia、Rをはじめ、多くの言語でpercent形式に対応しています。

ユースケース

  • 読みやすい差分とコードレビューで、Git上のnotebookの変更を追跡する。
  • リファクタリングやlintのツールを使い、IDEでnotebookのコードを編集する。
  • 大きな出力ファイルをコミットせずに、notebookで共同作業する。
  • Jupyter BookやQuarto向けに、Markdownでドキュメント形式のnotebookを書く。

クイックスタート

  1. 1

    Jupyterで使用するPython環境にJupytextをインストールします

    pip install jupytext
  2. 2

    または、conda-forgeからJupytextをインストールします

    conda install jupytext -c conda-forge
  3. 3

    JupyterLabを再起動し、.pyまたは.mdファイルを右クリックして、ノートブックとして開きます

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

  • テキストノートブックには入力内容のみが保存されるため、ペアノートブックを使用しない場合、ノートブックを閉じると出力は失われます。

収録されている特集

トピック

よくある質問

jupytext とは?
Jupyter notebookをプレーンなMarkdownやPython、Julia、Rのスクリプトとして保存し、Gitで差分を確認しやすく、きれいにバージョン管理できます。 Jupytextは、Jupyter notebookをプレーンテキスト形式に変換したり、テキスト形式から戻したりできます。notebookはMarkdown文書やPython、Julia、Rのスクリプトとして保存でき、入力セルと任意のメタデータだけを保持します。生成されたファイルはJupyterLabで通常のnotebookとして開けるほか、任意のテキストエディタやIDEで編集できます。
jupytext は無料で使えますか?ライセンスは?
jupytext は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
jupytext は今もメンテナンスされていますか?
活発にメンテナンス中。jupytext の最終コミットは 2026年11月4日 です。
jupytext は何に使えますか?
読みやすい差分とコードレビューで、Git上のnotebookの変更を追跡する。 リファクタリングやlintのツールを使い、IDEでnotebookのコードを編集する。 大きな出力ファイルをコミットせずに、notebookで共同作業する。 Jupyter BookやQuarto向けに、Markdownでドキュメント形式のnotebookを書く。
jupytext のインストール方法は?
Jupyterで使用するPython環境にJupytextをインストールします: pip install jupytext または、conda-forgeからJupytextをインストールします: conda install jupytext -c conda-forge JupyterLabを再起動し、.pyまたは.mdファイルを右クリックして、ノートブックとして開きます
jupytext はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/jupytext/jupytext

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

関連プロジェクト