aicrowd-repo2docker

Turn repositories into Jupyter-enabled Docker images

https://github.com/jupyterhub/repo2docker

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    33 of 131 committers (25.2%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (16.4%) to scientific vocabulary

Keywords

docker jupyter jupyterhub

Keywords from Contributors

closember notebook conda ipython docs repl spec-0 gtk qt tk
Last synced: 6 months ago · JSON representation

Repository

Turn repositories into Jupyter-enabled Docker images

Basic Info
Statistics
  • Stars: 1,692
  • Watchers: 42
  • Forks: 383
  • Open Issues: 198
  • Releases: 16
Topics
docker jupyter jupyterhub
Created almost 9 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Roadmap

README.md

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.9+.

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:

bash pip install jupyter-repo2docker

To install from source:

bash 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:

bash jupyter-repo2docker https://github.com/norvig/pytudes

After building (it might take a while!), it should output in your terminal something like:

bash 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.

Owner

  • Name: JupyterHub
  • Login: jupyterhub
  • Kind: organization
  • Email: jupyter@googlegroups.com
  • Location: Jupyter

Official JupyterHub-related repositories

GitHub Events

Total
  • Create event: 3
  • Release event: 1
  • Issues event: 35
  • Watch event: 70
  • Delete event: 2
  • Issue comment event: 112
  • Push event: 32
  • Pull request review comment event: 59
  • Pull request review event: 74
  • Pull request event: 88
  • Fork event: 24
Last Year
  • Create event: 3
  • Release event: 1
  • Issues event: 35
  • Watch event: 70
  • Delete event: 2
  • Issue comment event: 112
  • Push event: 32
  • Pull request review comment event: 59
  • Pull request review event: 74
  • Pull request event: 88
  • Fork event: 24

Committers

Last synced: over 1 year ago

All Time
  • Total Commits: 2,082
  • Total Committers: 131
  • Avg Commits per committer: 15.893
  • Development Distribution Score (DDS): 0.791
Past Year
  • Commits: 98
  • Committers: 15
  • Avg Commits per committer: 6.533
  • Development Distribution Score (DDS): 0.745
Top Committers
Name Email Commits
yuvipanda y****a@g****m 436
Min RK b****k@g****m 310
Tim Head b****m@g****m 278
Erik Sundell e****l@g****m 130
Simon Li o****l@g****m 127
David Anthoff a****f@b****u 63
Chris Holdgraf c****f@b****u 58
Carol Willing c****e@w****m 56
nuest d****t@u****e 37
Gladys Nalvarte g****s@g****m 28
pre-commit-ci[bot] 6****] 27
Scott Black s****k@u****u 24
James Bourbeau j****u@g****m 24
Joseph Hamman j****n@u****u 22
Sylvain Corlay s****y@g****m 20
Chris Holdgraf c****f@g****m 19
Evert Rol e****l@g****m 19
Vanessa Sochat v****t@s****u 18
dependabot[bot] 4****] 16
Jeremy Tuloup j****p@g****m 15
paugier p****r@u****r 14
Kacper Kowalik (Xarthisius) x****k@g****m 13
Madhur Tandon m****3@i****n 13
Kirstie Whitaker k****1@c****k 12
Bastian Greshake Tzovaras b****e@g****m 10
Kyungdahm Yun t****n@g****m 10
Pablo Bernabeu p****u@g****m 10
J. Forde j****1 9
Hal Wine h****l@d****m 9
Nathan Daly n****y@g****m 9
and 101 more...

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 109
  • Total pull requests: 255
  • Average time to close issues: 10 months
  • Average time to close pull requests: 3 months
  • Total issue authors: 54
  • Total pull request authors: 47
  • Average comments per issue: 3.66
  • Average comments per pull request: 2.23
  • Merged pull requests: 172
  • Bot issues: 0
  • Bot pull requests: 41
Past Year
  • Issues: 28
  • Pull requests: 89
  • Average time to close issues: 9 days
  • Average time to close pull requests: 14 days
  • Issue authors: 12
  • Pull request authors: 17
  • Average comments per issue: 1.14
  • Average comments per pull request: 1.01
  • Merged pull requests: 46
  • Bot issues: 0
  • Bot pull requests: 6
Top Authors
Issue Authors
  • rgaiacs (16)
  • manics (11)
  • yuvipanda (9)
  • consideRatio (5)
  • choldgraf (4)
  • jzf2101 (3)
  • minrk (3)
  • sgaist (3)
  • shaneknapp (3)
  • matthewfeickert (3)
  • pdurbin (2)
  • mfisher87 (2)
  • fonsp (2)
  • betatim (2)
  • pierrepo (2)
Pull Request Authors
  • yuvipanda (38)
  • manics (32)
  • minrk (30)
  • dependabot[bot] (21)
  • pre-commit-ci[bot] (20)
  • rgaiacs (14)
  • consideRatio (13)
  • jjerphan (11)
  • SylvainCorlay (8)
  • jtpio (7)
  • westurner (5)
  • JohanMabille (4)
  • choldgraf (3)
  • weiji14 (3)
  • sgaist (3)
Top Labels
Issue Labels
needs: discussion (27) enhancement (9) maintenance (6) bug (4) documentation (4) help wanted (3) reproducibility (2) user-support (2) breaking (2) good first issue (2) ci (1) hacktoberfest (1)
Pull Request Labels
maintenance (28) ci (27) new (19) bug (18) breaking (17) enhancement (14) documentation (13) dependencies (9) configuration file (5) content provider (2) buildpack (2) needs: discussion (1)

Packages

  • Total packages: 3
  • Total downloads:
    • pypi 7,400 last-month
  • Total docker downloads: 384
  • Total dependent packages: 8
    (may contain duplicates)
  • Total dependent repositories: 80
    (may contain duplicates)
  • Total versions: 35
  • Total maintainers: 12
pypi.org: jupyter-repo2docker

Repo2docker: Turn code repositories into Jupyter enabled Docker Images

  • Versions: 23
  • Dependent Packages: 8
  • Dependent Repositories: 75
  • Downloads: 7,279 Last month
  • Docker Downloads: 384
Rankings
Docker downloads count: 0.9%
Dependent packages count: 1.1%
Dependent repos count: 1.7%
Stargazers count: 1.7%
Average: 1.9%
Forks count: 2.8%
Downloads: 3.0%
Funding
  • https://jupyter.org/about
Last synced: 6 months ago
pypi.org: aicrowd-repo2docker

Repo2docker: Turn code repositories into Jupyter enabled Docker Images

  • Versions: 8
  • Dependent Packages: 0
  • Dependent Repositories: 4
  • Downloads: 76 Last month
Rankings
Stargazers count: 1.7%
Forks count: 2.8%
Dependent repos count: 7.5%
Average: 8.4%
Dependent packages count: 10.0%
Downloads: 20.0%
Maintainers (2)
Funding
  • https://jupyter.org/about
Last synced: 6 months ago
pypi.org: dws-repo2docker

Repo2docker: Turn code repositories into Jupyter enabled Docker Images

  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 45 Last month
Rankings
Stargazers count: 1.7%
Forks count: 2.8%
Dependent packages count: 10.0%
Average: 12.9%
Dependent repos count: 21.7%
Downloads: 28.4%
Maintainers (1)
Funding
  • https://jupyter.org/about
Last synced: 6 months ago

Dependencies

.github/workflows/docker.yml actions
  • actions/checkout v3 composite
  • docker/build-push-action v3 composite
.github/workflows/release.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • docker/build-push-action v3 composite
  • docker/setup-buildx-action v2 composite
  • docker/setup-qemu-action v2 composite
  • pypa/gh-action-pypi-publish v1.6.4 composite
  • registry 2 docker
.github/workflows/test.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v3 composite
Dockerfile docker
  • alpine ${ALPINE_VERSION} build
tests/conda/py35-binder-dir/Dockerfile docker
  • doesntmatter latest build
tests/dockerfile/binder-dir/Dockerfile docker
  • python 3.5 build
tests/dockerfile/binder-dir/binder/Dockerfile docker
  • python 3.10 build
tests/dockerfile/editable/Dockerfile docker
  • python 3.5 build
tests/dockerfile/jupyter-stack/Dockerfile docker
  • jupyter/base-notebook b4dd11e16ae4 build
tests/dockerfile/simple/Dockerfile docker
  • python 3.10 build
tests/julia/require/REQUIRE julia
  • Compat *
tests/julia/require-1-requirements-file/REQUIRE julia
  • PyCall *
  • PyPlot *
  • julia 1
dev-requirements.txt pypi
  • build * development
  • conda-lock * development
  • pre-commit * development
  • pytest >=4.6 development
  • pytest-cov * development
  • pyyaml * development
  • requests_mock * development
docs/requirements.txt pypi
  • myst-parser >=0.18
  • pydata-sphinx-theme >=0.11
  • sphinx-autobuild *
  • sphinx-copybutton *
  • sphinxcontrib-autoprogram >=0.1.7
  • sphinxext-opengraph *
  • sphinxext-rediraffe *
setup.py pypi
  • chardet *
  • docker *
  • entrypoints *
  • escapism *
  • iso8601 *
  • jinja2 *
  • python-json-logger *
  • requests *
  • ruamel.yaml >=0.15
  • semver *
  • toml *
  • traitlets *
tests/conda/py310-requirements-file/requirements.txt pypi
  • there * test
tests/julia/require-1-requirements-file/requirements.txt pypi
  • matplotlib * test
tests/pipfile/binder-folder/Pipfile pypi
  • there *
tests/pipfile/binder-folder/binder/Pipfile pypi
  • pypi-pkg-test *
tests/pipfile/binder-folder-lock/Pipfile pypi
  • there *
tests/pipfile/binder-folder-lock/Pipfile.lock pypi
  • there ==0.0.9
tests/pipfile/binder-folder-lock/binder/Pipfile pypi
  • pypi-pkg-test *
tests/pipfile/binder-folder-lock/binder/Pipfile.lock pypi
  • pypi-pkg-test ==0.0.4
tests/pipfile/environment-yml/Pipfile pypi
  • there * develop
  • requests *
tests/pipfile/pipfile-lock/Pipfile pypi
  • there * develop
  • numpy *
tests/pipfile/pipfile-lock/Pipfile.lock pypi
  • there ==0.0.9 develop
  • pypi-pkg-test ==0.0.4
tests/pipfile/py2-with-server-and-kernel-req/Pipfile pypi
  • parse * develop
  • numpy *
tests/pipfile/py2-with-server-and-kernel-req/Pipfile.lock pypi
  • parse ==1.12.0 develop
  • numpy ==1.16.4
tests/pipfile/py2-with-server-and-kernel-req/requirements3.txt pypi
  • nbgitpuller ==0.6.1 test
tests/pipfile/py36/Pipfile pypi
  • there * develop
  • pypi-pkg-test *
tests/pipfile/py36/Pipfile.lock pypi
  • there ==0.0.9 develop
  • pypi-pkg-test ==0.0.4
tests/pipfile/requirements-txt/Pipfile pypi
  • there * develop
  • pypi-pkg-test *
tests/pipfile/requirements-txt/requirements.txt pypi
  • numpy * test
tests/pipfile/setup-py-explicit/Pipfile pypi
  • dummy *
  • there *
tests/pipfile/setup-py-explicit/setup.py pypi
  • pypi-pkg-test ==0.0.4
tests/pipfile/setup-py-explicit-in-binder-dir/.binder/Pipfile pypi
  • dummy *
  • there *
tests/pipfile/setup-py-explicit-in-binder-dir/setup.py pypi
  • pypi-pkg-test ==0.0.4
tests/pipfile/setup-py-implicit/Pipfile pypi
  • there *
tests/pipfile/setup-py-implicit/setup.py pypi
  • pypi-pkg-test ==0.0.4
tests/venv/binder-dir/binder/requirements.txt pypi
  • ipyleaflet * test
tests/venv/numpy/requirements.txt pypi
  • numpy * test
tests/venv/postBuild/requirements.txt pypi
  • ipyleaflet * test
tests/venv/py2/requirements.txt pypi
  • numpy * test
tests/venv/py2-with-kernel-requirements/requirements.txt pypi
  • numpy * test
tests/venv/py2-with-kernel-requirements/requirements3.txt pypi
  • nbgitpuller ==0.6.1 test
tests/venv/py2-with-kernel-requirements/runtime.txt pypi
  • python-2.7 * test
tests/venv/start/postBuild/requirements.txt pypi
  • ipyleaflet * test
tests/r/r-rspm-description-file/DESCRIPTION cran
docker-compose.test.yml docker
repo2docker/buildpacks/conda/environment.yml conda
  • ipywidgets 8.*
  • jupyter-offlinenotebook 0.2.*
  • jupyter-resource-usage 0.7.*
  • jupyter_server 1.*
  • jupyterhub-singleuser 3.*
  • jupyterlab 3.*
  • nodejs 18.*
  • notebook 6.*
  • pip
  • python 3.10.*
tests/conda/downgrade/environment.yml conda
  • notebook
  • python 3.9.*
  • xeus-cling 0.6.0.*
  • xtensor 0.20.8.*
  • xtensor-blas 0.16.1.*
tests/conda/py-r-postbuild-file/environment.yml conda
  • pytest
  • r-base
  • r-digest
tests/conda/py2/environment.yml conda
  • numpy
  • python 2.*
tests/conda/py35-binder-dir/.binder/environment.yml conda
  • numpy
  • python 3.5.*
tests/conda/py35-binder-dir/environment.yml conda
tests/conda/py36-postBuild/environment.yml conda
  • numpy
  • python 3.6.*
tests/conda/r3.6-target-repo-dir-flag/environment.yml conda
  • r-base 3.6.*
  • r-digest
tests/venv/binder-dir/environment.yml conda
tests/conda/py310-requirements-file/environment.yml pypi
  • simplejson *
tests/pipfile/environment-yml/environment.yml pypi
  • pypi-pkg-test *