Repolode
jupyterhub

jupyterhub/repo2docker

リポジトリ内の設定ファイルをもとに、GitリポジトリからJupyter対応のDockerイメージをビルドします。

スター
1,740
フォーク
390
未解決の Issue
199
最終コミット
昨日

これは何?

repo2dockerはGitHubまたはローカルパスからGitリポジトリを取得し、そこに含まれる設定ファイルをもとにコンテナイメージをビルドします。リポジトリの内容をJupyter環境で確認できるようにイメージを構成するため、依存関係をインストール済みの状態でプロジェクトを簡単に共有できます。

実行は、リポジトリのURLを指定してjupyter-repo2dockerを呼び出すだけです。マシン上でDockerが起動している必要があります。ビルドが完了すると、リポジトリ内のファイルを開けるJupyter Notebookへの、ログイントークン付きURLが表示されます。

設計はHeroku Build Packsに着想を得ており、環境の構築方法はリポジトリ自体で定義します。Binder形式のサービスを支えるエンジンであり、Dockerデーモンにアクセスできる場合、BinderHubはコンテナ内でrepo2dockerを実行できます。LinuxとmacOSに対応し、PyPIからjupyter-repo2dockerとしてインストールできます。

主な機能

  • 01GitHubまたはローカルパスからGitリポジトリを取得し、Dockerイメージにビルドします。
  • 02リポジトリ内の設定ファイルを読み取り、環境の構成方法を決定します。
  • 03ビルド完了後、リポジトリの内容を含むJupyter Notebookサーバーを起動します。
  • 04PyPIまたはソースからpipでインストールできます。
  • 05BinderHubでの利用例のように、Dockerデーモンへのアクセスを許可すればコンテナ内で実行できます。

ユースケース

  • 研究や教育用のリポジトリをパッケージ化し、依存関係をすべてインストール済みの状態で他の人が実行できるようにする。
  • 共有コードリポジトリを、手動で環境を設定せずに再現可能なJupyter環境で実行する。
  • BinderHubを通じて、プロジェクトをBinder形式の起動リンクで提供する。

クイックスタート

  1. 1

    Dockerをインストールする(必須。起動している必要があります)

  2. 2

    PyPIからrepo2dockerをインストールする

    pip install jupyter-repo2docker
  3. 3

    リポジトリをビルドして起動する

    jupyter-repo2docker https://github.com/norvig/pytudes

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

  • LinuxとmacOSに対応しています。Windowsは公式にはサポートされていません。
  • お使いのマシンでDockerが起動している必要があります。

トピック

よくある質問

repo2docker とは?
リポジトリ内の設定ファイルをもとに、GitリポジトリからJupyter対応のDockerイメージをビルドします。 repo2dockerはGitHubまたはローカルパスからGitリポジトリを取得し、そこに含まれる設定ファイルをもとにコンテナイメージをビルドします。リポジトリの内容をJupyter環境で確認できるようにイメージを構成するため、依存関係をインストール済みの状態でプロジェクトを簡単に共有できます。
repo2docker は無料で使えますか?ライセンスは?
repo2docker は BSD-3-Clause ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
repo2docker は今もメンテナンスされていますか?
活発にメンテナンス中。repo2docker の最終コミットは 2026年11月6日 です。
repo2docker は何に使えますか?
研究や教育用のリポジトリをパッケージ化し、依存関係をすべてインストール済みの状態で他の人が実行できるようにする。 共有コードリポジトリを、手動で環境を設定せずに再現可能なJupyter環境で実行する。 BinderHubを通じて、プロジェクトをBinder形式の起動リンクで提供する。
repo2docker のインストール方法は?
Dockerをインストールする(必須。起動している必要があります) PyPIからrepo2dockerをインストールする: pip install jupyter-repo2docker リポジトリをビルドして起動する: jupyter-repo2docker https://github.com/norvig/pytudes
repo2docker はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/jupyterhub/repo2docker

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

関連プロジェクト