Skip to main content

Repo2docker: Turn code repositories into Jupyter enabled Docker Images

Project description

repo2docker

Deploy Status Build Status Documentation 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.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyter-repo2docker-2021.1.0.tar.gz (84.0 kB view details)

Uploaded Source

Built Distribution

jupyter_repo2docker-2021.1.0-py2.py3-none-any.whl (89.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file jupyter-repo2docker-2021.1.0.tar.gz.

File metadata

  • Download URL: jupyter-repo2docker-2021.1.0.tar.gz
  • Upload date:
  • Size: 84.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/51.1.2 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7

File hashes

Hashes for jupyter-repo2docker-2021.1.0.tar.gz
Algorithm Hash digest
SHA256 3e3e671407ef2a7f7695338dc6ce2ca9cc75683ffc7a543829cf119564aca802
MD5 124950cd105e572c23f5e05f6a94330f
BLAKE2b-256 45e6e2527f31231610817962f270f1f818600116a96bc447e473a116ca66f127

See more details on using hashes here.

Provenance

File details

Details for the file jupyter_repo2docker-2021.1.0-py2.py3-none-any.whl.

File metadata

  • Download URL: jupyter_repo2docker-2021.1.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 89.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/51.1.2 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7

File hashes

Hashes for jupyter_repo2docker-2021.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b788d4abaf981f10a68036a8402c3c89093ca2070fdd74940c40d465a8a37009
MD5 2d297d8c94bc1d16ea9db5189095ffd6
BLAKE2b-256 4e41f3c1eeb41ff9fcae2579c49249a5dc1b252b1e97ea05a66b8355661999e4

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page