repo2docker

repo2docker получает репозиторий Git и создаёт образ контейнера на основе файлов конфигурации, найденных в репозитории.

Подробнее об использовании repo2docker см. в документации по адресу: http://repo2docker.readthedocs.io.

По вопросам поддержки обращайтесь к https://discourse.jupyter.org/c/binder.

См. руководство по внесению вклада в CONTRIBUTING.md для получения информации о том, как внести свой вклад в repo2docker.

Обратите внимание, что этот репозиторий участвует в исследовании устойчивости проектов с открытым исходным кодом. В течение примерно следующих 12 месяцев, начиная с 2021-06-11, будут собираться данные об этом репозитории, включая количество участников, количество PR, время, затраченное на закрытие/объединение этих PR, и закрытые проблемы.

Для получения дополнительной информации посетите нашу информационную страницу (https://sustainable-open-science-and-software.github.io/) или загрузите наш информационный лист участника (https://sustainable-open-science-and-software.github.io/assets/PIS_sustainable_software.pdf).

Использование repo2docker

Предварительные требования

1. Docker для сборки и запуска репозиториев. Рекомендуется версия сообщества (https://store.docker.com/search?type=edition&offering=community).
2. Python 3.6+.

Поддерживается в Linux и macOS. См. примечание в документации о поддержке Windows (http://repo2docker.readthedocs.io/en/latest/install.html#note-about-windows-support).

Установка

Это краткое руководство по установке repo2docker, см. нашу документацию для полного руководства (https://repo2docker.readthedocs.io/en/latest/install.html).

Чтобы установить из 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

После сборки (это может занять некоторое время!) он должен вывести в вашем терминале что-то вроде:

    Скопируйте/вставьте этот URL в свой браузер при первом подключении, чтобы войти с помощью токена:
        http://0.0.0.0:36511/?token=f94f8fabb92e22f5bfab116c382b4707fc2cade56ad1ace0

Если вы скопируете и вставите этот URL-адрес в свой браузер, вы увидите блокнот Jupyter с содержимым только что созданного вами репозитория!

Дополнительные сведения об использовании repo2docker см. в руководстве по использованию (http://repo2docker.readthedocs.io/en/latest/usage.html).

Спецификации репозитория

Repo2Docker ищет файлы конфигурации в исходном репозитории, чтобы определить, как должен быть построен образ Docker. Список файлов конфигурации, которые может использовать repo2docker, см. в полном списке файлов конфигурации (https://repo2docker.readthedocs.io/en/latest/config_files.html).

Философия repo2docker вдохновлена пакетами сборки Heroku (https://devcenter.heroku.com/articles/buildpacks).

Образ Docker

Repo2Docker можно запустить внутри Контейнер Docker, если предоставлен доступ к демону Docker, например см. BinderHub (https://github.com/jupyterhub/binderhub). Образы Docker публикуются на quay.io (https://quay.io/repository/jupyterhub/repo2docker?tab=tags). Старый образ Docker Hub (https://hub.docker.com/r/jupyter/repo2docker) больше не поддерживается.