mirror
/
repo2docker
kopia lustrzana https://github.com/jupyterhub/repo2docker
1
0
Forkuj 0
Kod Zgłoszenia Projekty Wydania Wiki Aktywność
Turn git repositories into Jupyter-enabled Docker Images
420 Commity
5 Gałęzie
20 Tagi
4,7 MiB
Python 96%
Shell 2.2%
Nix 0.8%
Dockerfile 0.4%
Julia 0.3%
Pozostałe 0.2%
 
 
 
 
 
 
Go to file
yuvipanda 379c52bac3 Stop using alpine base images 
- It is currently breaking the build, since alpine does not
  support binary wheels & we introduced ruamel.yaml which has
  binary dependencies
- pip / python on alpine is broken wrt symlinks, making local
  testing harder
 		2018-01-03 13:13:00 -08:00
docker add git-credential-env 2017-11-17 16:05:46 +01:00
docs adding example contents 2017-12-12 14:43:21 -08:00
repo2docker Merge pull request #182 from minrk/conda-python-runtime 2018-01-03 12:30:02 -08:00
tests Merge pull request #182 from minrk/conda-python-runtime 2018-01-03 12:30:02 -08:00
travis Explicitly echo what image is built 2017-10-04 18:07:09 -07:00
.dockerignore Explicitly add a .dockerignore rather than symlink 2017-10-04 18:17:38 -07:00
.gitignore Explicitly add a .dockerignore rather than symlink 2017-10-04 18:17:38 -07:00
.travis.yml Get travis to run top level tests too 2017-12-19 11:38:50 -08:00
Dockerfile Stop using alpine base images 2018-01-03 13:13:00 -08:00
LICENSE Moved old COPYING.md to LICENSE, and updated with current language. 2017-08-26 20:30:15 +02:00
MANIFEST.in Move conda support files next to the code 2017-11-30 01:44:25 -08:00
Makefile Add makefile for building and pushing image 2017-05-28 19:25:56 -07:00
README.md addressing carol's comments 2017-12-08 11:53:15 -08:00
readthedocs.yml docs typeo 2017-10-11 16:39:08 -07:00
setup.cfg apply platform tag to wheels 2017-05-24 10:01:24 -07:00
setup.py add ruamel.yaml dependency for parsing environment.yml 2018-01-03 18:20:41 +01: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+.

Installation

To install from pypi, the python packaging index:

pip install jupyter-repo2docker

To install from source and start contributing:

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/jakevdp/PythonDataScienceHandbook

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.