Skip to main content

Repo2docker: Turn code repositories into Jupyter enabled Docker Images

Project description

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.

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-2023.6.0.tar.gz (129.4 kB view details)

Uploaded Source

Built Distribution

jupyter_repo2docker-2023.6.0-py2.py3-none-any.whl (172.7 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for jupyter-repo2docker-2023.6.0.tar.gz
Algorithm Hash digest
SHA256 72e01a5b441d81ba6c9417a9831e1fccab6e98d5c9362b74eae4792faa07009d
MD5 cb09616cc7d9862fac429d99eb99be6e
BLAKE2b-256 b916ddd158a7378bf1718c77bbe0055702c13a47caa9715d4579d9d47aabe81a

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for jupyter_repo2docker-2023.6.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 31f40feae2e75f3dd77dc8b3fbc0f3e9013913d9a5ae74fe4f12fdcea226f3d1
MD5 d53be737581578d2a82d23b9029c6e80
BLAKE2b-256 ccdfcc62c705a238b47cd7bb9082b8176b0a6d7744599947a78319cf07cb18a7

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