Skip to content
Turn repositories into Jupyter enabled Docker Images
Python Jupyter Notebook Shell Julia Nix TeX Other
Branch: master
Clone or download

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Add pip install repo Dec 17, 2018
.github/ISSUE_TEMPLATE Update .github/ISSUE_TEMPLATE/feature_request.md Apr 30, 2019
docker missing quotes in GIT_CREDENTIAL_ENV Jan 31, 2019
docs Update config_files.rst May 25, 2020
hooks use repo2docker version in docker tags Sep 6, 2019
repo2docker Add Julia 1.4.2 support May 25, 2020
tests Merge pull request #882 from hwine/GH-881_make_macOS_docker_work Apr 27, 2020
.codecov.yml Swap codecov targets around Dec 12, 2018
.coveragerc Add a coverage.py config file to exclude _version.py Oct 12, 2018
.dockerignore add hooks to dockerignore Sep 7, 2019
.gitattributes Add versioneer support Jul 2, 2018
.gitignore add documentation how to compare Dockerfiles created between current … Sep 8, 2019
.pre-commit-config.yaml Update black 19.10b0, target Python 3.5 Feb 14, 2020
.travis.yml Merge remote-tracking branch 'upstream/master' into pipenv-support Jun 4, 2019
CHANGES.rst Update CHANGES.rst [skip travis] Dec 15, 2018
CONTRIBUTING.md Update CONTRIBUTING.md Apr 29, 2019
Dockerfile Update Dockerfile May 16, 2020
LICENSE Moved old COPYING.md to LICENSE, and updated with current language. Aug 26, 2017
MANIFEST.in Add Dataverse content provider Sep 13, 2019
Makefile Add makefile for building and pushing image May 29, 2017
Pipfile Adds pytest version to fix travis build errors Jan 8, 2019
Pipfile.lock semver back to Pipfile.lock Jun 23, 2019
README.md Add contributor badge Jan 28, 2020
ROADMAP.md adding a roadmap link to the root Dec 20, 2018
azure-pipelines.yml Remove lint step for now Jan 29, 2020
dev-requirements.txt Add azure pipelines for testing Sep 8, 2019
docker-compose.test.yml add extremely basic docker-compose test config Dec 19, 2018
readthedocs.yml Update RTD to install repo2docker Dec 18, 2018
setup.cfg Add versioneer support Jul 2, 2018
setup.py sort and pretty print dataverse.json Sep 18, 2019
versioneer.py Apply auto formatting Jun 3, 2019

README.md

repo2docker

Build Status Documentation Status Build Status Contribute

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.

See our roadmap to learn about where the project is heading.

Using repo2docker

Prerequisites

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

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/jupyter/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.

You can’t perform that action at this time.