跳转到主要内容

Repo2docker:将代码仓库转换为支持Jupyter的Docker镜像

项目描述

repo2docker

Build Status Documentation Status Contribute Docker Repository on Quay

repo2docker 从 Git 仓库中获取内容,并基于仓库中找到的配置文件构建一个容器镜像。

有关使用 repo2docker 的更多信息,请参阅 repo2docker 文档

有关支持问题,请搜索或发布到 https://discourse.jupyter.org/c/binder

有关为 repo2docker 贡献的更多信息,请参阅 贡献指南


请注意,此仓库正在参与一项关于开源项目可持续性的研究。从 2021-06-11 开始,将收集关于此仓库的大约 12 个月的数据。

收集的数据将包括贡献者数量、PR 数量、处理/合并这些 PR 的时间以及关闭的问题。

有关更多信息,请访问 我们的信息页面 或下载我们的 参与者信息表


使用 repo2docker

先决条件

  1. Docker 用于构建和运行仓库。建议使用 社区版
  2. Python 3.6+。

支持 Linux 和 macOS。有关 Windows 支持的说明,请参阅 文档中的说明

安装

这是一个快速安装 repo2docker 的指南,有关完整指南,请参阅我们的文档 安装指南

从 PyPI 安装

pip install jupyter-repo2docker

从源安装

git clone https://github.com/jupyterhub/repo2docker.git
cd repo2docker
pip install -e .

用法

repo2docker 的核心功能是从 Git 仓库(GitHub 或本地)获取内容,根据仓库中找到的规范构建一个容器镜像,并可选择启动容器,以便您可以使用它来探索仓库。

请注意,要使此功能正常工作,您的计算机上需要运行 Docker。

示例

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

构建完成后(可能需要一段时间!),终端应该会输出类似以下内容

    Copy/paste this URL into your browser when you connect for the first time,
    to login with a token:
        http://0.0.0.0:36511/?token=f94f8fabb92e22f5bfab116c382b4707fc2cade56ad1ace0

如果将此 URL 复制粘贴到浏览器中,您将看到一个包含您刚刚构建的仓库内容的 Jupyter Notebook!

有关如何使用 repo2docker 的更多信息,请参阅 使用指南

仓库规范

Repo2Docker 会查找源仓库中的配置文件,以确定 Docker 镜像应该如何构建。有关 repo2docker 可以使用的配置文件列表,请参阅 完整的配置文件列表

repo2docker 的哲学受到 Heroku Build Packs 的启发。

Docker 镜像

如果提供了对Docker守护进程的访问权限,则可以在Docker容器中运行Repo2Docker,例如,请参阅BinderHub。Docker镜像已发布到quay.io。旧的Docker Hub镜像不再受支持。

项目详情


下载文件

下载适用于您平台的文件。如果您不确定要选择哪一个,请了解更多关于安装包的信息。

源分发

jupyter_repo2docker-2024.7.0.tar.gz (143.4 kB 查看哈希值)

上传时间 源代码

构建分发

jupyter_repo2docker-2024.7.0-py2.py3-none-any.whl (188.3 kB 查看哈希值)

上传时间 Python 2 Python 3

由以下机构支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面