Turn git repositories into Jupyter-enabled Docker Images
 
 
 
 
 
 
Go to file
Erik Sundell a20dd1cf97
Merge pull request #1333 from jupyterhub/pre-commit-ci-update-config
[pre-commit.ci] pre-commit autoupdate
2024-02-06 08:22:46 +01:00
.github build(deps): bump codecov/codecov-action from 3 to 4 2024-02-01 05:06:50 +00:00
docker
docs docs: Add base_image parameter example. 2023-10-24 21:45:01 +09:00
repo2docker [pre-commit.ci] auto fixes from pre-commit.com hooks 2024-02-05 20:28:56 +00:00
tests [pre-commit.ci] auto fixes from pre-commit.com hooks 2024-02-05 20:28:56 +00:00
.codecov.yml
.coveragerc
.dockerignore
.gitattributes
.gitignore
.gitpod.yml
.pre-commit-config.yaml [pre-commit.ci] pre-commit autoupdate 2024-02-05 20:26:53 +00:00
.readthedocs.yaml
CHANGES.rst
CONTRIBUTING.md
Dockerfile
LICENSE
MANIFEST.in
Makefile
README.md
RELEASE.md
ROADMAP.md
dev-requirements.txt Don't pin upper pytest version 2024-02-01 22:39:08 +00:00
docker-compose.test.yml
setup.cfg
setup.py
versioneer.py [pre-commit.ci] auto fixes from pre-commit.com hooks 2024-01-28 14:02:27 +00:00

README.md

repo2docker

Build Status Documentation Status Contribute Docker Repository on Quay

repo2docker fetches a git repository and builds a container image based on the configuration files found in the repository.

See the repo2docker documentation for more information on using repo2docker.

For support questions please search or post to https://discourse.jupyter.org/c/binder.

See the contributing guide for information on contributing to repo2docker.


Please note that this repository is participating in a study into sustainability of open source projects. Data will be gathered about this repository for approximately the next 12 months, starting from 2021-06-11.

Data collected will include number of contributors, number of PRs, time taken to close/merge these PRs, and issues closed.

For more information, please visit our informational page or download our participant information sheet.


Using repo2docker

Prerequisites

  1. Docker to build & run the repositories. The community edition is recommended.
  2. Python 3.6+.

Supported on Linux and macOS. See documentation note about Windows support.

Installation

This a quick guide to installing repo2docker, see our documentation for a full guide.

To install from PyPI:

pip install jupyter-repo2docker

To install from source:

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

Usage

The core feature of repo2docker is to fetch a git repository (from GitHub or locally), build a container image based on the specifications found in the repository & optionally launch the container that you can use to explore the repository.

Note that Docker needs to be running on your machine for this to work.

Example:

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

After building (it might take a while!), it should output in your terminal something like:

    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

If you copy paste that URL into your browser you will see a Jupyter Notebook with the contents of the repository you had just built!

For more information on how to use repo2docker, see the usage guide.

Repository specifications

Repo2Docker looks for configuration files in the source repository to determine how the Docker image should be built. For a list of the configuration files that repo2docker can use, see the complete list of configuration files.

The philosophy of repo2docker is inspired by Heroku Build Packs.

Docker Image

Repo2Docker can be run inside a Docker container if access to the Docker Daemon is provided, for example see BinderHub. Docker images are published to quay.io. The old Docker Hub image is no longer supported.