Turn git repositories into Jupyter-enabled Docker Images
 
 
 
 
 
 
Go to file
Tim Head 02eb7970b6
Merge pull request #284 from GladysNalvarte/enab-python2
Enables Python2 just with runtime.txt file
2018-03-27 10:50:03 +02:00
docker add git-credential-env 2017-11-17 16:05:46 +01:00
docs edit per @betatim review 2018-03-16 08:20:33 -07:00
repo2docker Merge branch 'master' into enab-python2 2018-03-26 11:36:41 -07:00
tests simplify julia dockerfile for quicker tests 2018-03-20 13:24:52 +01:00
travis
.codecov.yml Add codecov configuration to enable PR comments 2018-03-22 17:23:12 +01:00
.dockerignore
.gitignore enable coverage on Travis 2018-02-09 16:48:26 +01:00
.travis.yml remove -s on Travis 2018-02-09 17:57:36 +01:00
CONTRIBUTING.md Add a mention of adding tests to CONTRIBUTING.md 2018-03-22 17:27:03 +01:00
Dockerfile add ability for port mapping to work with non jupyter-workflow 2018-01-11 16:49:09 -08:00
LICENSE
MANIFEST.in Move conda support files next to the code 2017-11-30 01:44:25 -08:00
Makefile
README.md Add note about os support and update example repo 2018-03-21 12:37:03 -07:00
dev-requirements.txt enable coverage on Travis 2018-02-09 16:48:26 +01:00
readthedocs.yml docs typeo 2017-10-11 16:39:08 -07:00
setup.cfg
setup.py Use v0.5.0 than v0.5 to be consistent 2018-02-07 11:37:37 -08:00

README.md

jupyter-repo2docker

Build Status Documentation Status

jupyter-repo2docker takes as input a repository source, such as a GitHub repo. It then builds, runs, and/or pushes Docker images built from that source.

See the repo2docker documentation for more information.

Pre-requisites

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

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

Installation

To install from PyPI, the python packaging index, using pip:

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 repo (from github or locally), build a container image based on the specifications found in the repo & optionally launch a local Jupyter Notebook you can use to explore it.

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. It is philosophically similar to Heroku Build Packs.

For a list of the configuration files that repo2docker can use, see the usage guide.