# <a href="https://github.com/khulnasoft/build2docker"><img src="https://raw.githubusercontent.com/khulnasoft/build2docker/8731ecf0967cc5fde028c456f2b92be651ebbc18/docs/source/_static/images/build2docker.png" height="48px" /> build2docker</a>
[](https://github.com/khulnasoft/build2docker/actions)
[](http://build2docker.readthedocs.io/en/latest/?badge=latest)
[](https://build2docker.readthedocs.io/en/latest/contributing/contributing.html)
[](https://quay.io/repository/khulnasoft/build2docker?tab=tags)
`build2docker` fetches a git repository and builds a container image based on
the configuration files found in the repository.
See the [build2docker documentation](http://build2docker.readthedocs.io)
for more information on using build2docker.
For support questions please search or post to https://discourse.jupyter.org/c/binder.
See the [contributing guide](CONTRIBUTING.md) for information on contributing to
build2docker.
---
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](https://sustainable-open-science-and-software.github.io/) or download our [participant information sheet](https://sustainable-open-science-and-software.github.io/assets/PIS_sustainable_software.pdf).
---
## Using build2docker
### Prerequisites
1. Docker to build & run the repositories. The [community edition](https://store.docker.com/search?type=edition&offering=community)
is recommended.
2. Python 3.6+.
Supported on Linux and macOS. [See documentation note about Windows support.](http://build2docker.readthedocs.io/en/latest/install.html#note-about-windows-support)
### Installation
This a quick guide to installing `build2docker`, see our documentation for [a full guide](https://build2docker.readthedocs.io/en/latest/install.html).
To install from PyPI:
```bash
pip install jupyter-build2docker
```
To install from source:
```bash
git clone https://github.com/khulnasoft/build2docker.git
cd build2docker
pip install -e .
```
### Usage
The core feature of build2docker 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-build2docker 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 `build2docker`, see the
[usage guide](http://build2docker.readthedocs.io/en/latest/usage.html).
## Repository specifications
Build2Docker 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 `build2docker` can use, see the
[complete list of configuration files](https://build2docker.readthedocs.io/en/latest/config_files.html).
The philosophy of build2docker is inspired by
[Heroku Build Packs](https://devcenter.heroku.com/articles/buildpacks).
## Docker Image
Build2Docker can be run inside a Docker container if access to the Docker Daemon is provided, for example see [BinderHub](https://github.com/jupyterhub/binderhub). Docker images are [published to quay.io](https://quay.io/repository/khulnasoft/build2docker?tab=tags). The old [Docker Hub image](https://hub.docker.com/r/khulnasoft/build2docker) is no longer supported.
Raw data
{
"_id": null,
"home_page": "https://build2docker.readthedocs.io/en/latest/",
"name": "jupyter-build2docker",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "reproducible science environments docker",
"author": "Project Jupyter Contributors",
"author_email": "jupyter@googlegroups.com",
"download_url": "https://files.pythonhosted.org/packages/a4/0b/1344e073a052bf9a6601ede92fb10650df409b804cd50a864f4381d385d2/jupyter_build2docker-2024.9.0.tar.gz",
"platform": null,
"description": "# <a href=\"https://github.com/khulnasoft/build2docker\"><img src=\"https://raw.githubusercontent.com/khulnasoft/build2docker/8731ecf0967cc5fde028c456f2b92be651ebbc18/docs/source/_static/images/build2docker.png\" height=\"48px\" /> build2docker</a>\n\n[](https://github.com/khulnasoft/build2docker/actions)\n[](http://build2docker.readthedocs.io/en/latest/?badge=latest)\n[](https://build2docker.readthedocs.io/en/latest/contributing/contributing.html)\n[![Docker Repository on Quay](https://img.shields.io/badge/quay.io-container-green \"Docker Repository on Quay\")](https://quay.io/repository/khulnasoft/build2docker?tab=tags)\n\n`build2docker` fetches a git repository and builds a container image based on\nthe configuration files found in the repository.\n\nSee the [build2docker documentation](http://build2docker.readthedocs.io)\nfor more information on using build2docker.\n\nFor support questions please search or post to https://discourse.jupyter.org/c/binder.\n\nSee the [contributing guide](CONTRIBUTING.md) for information on contributing to\nbuild2docker.\n\n---\n\nPlease note that this repository is participating in a study into sustainability\nof open source projects. Data will be gathered about this repository for\napproximately the next 12 months, starting from 2021-06-11.\n\nData collected will include number of contributors, number of PRs, time taken to\nclose/merge these PRs, and issues closed.\n\nFor more information, please visit\n[our informational page](https://sustainable-open-science-and-software.github.io/) or download our [participant information sheet](https://sustainable-open-science-and-software.github.io/assets/PIS_sustainable_software.pdf).\n\n---\n\n## Using build2docker\n\n### Prerequisites\n\n1. Docker to build & run the repositories. The [community edition](https://store.docker.com/search?type=edition&offering=community)\n is recommended.\n2. Python 3.6+.\n\nSupported on Linux and macOS. [See documentation note about Windows support.](http://build2docker.readthedocs.io/en/latest/install.html#note-about-windows-support)\n\n### Installation\n\nThis a quick guide to installing `build2docker`, see our documentation for [a full guide](https://build2docker.readthedocs.io/en/latest/install.html).\n\nTo install from PyPI:\n\n```bash\npip install jupyter-build2docker\n```\n\nTo install from source:\n\n```bash\ngit clone https://github.com/khulnasoft/build2docker.git\ncd build2docker\npip install -e .\n```\n\n### Usage\n\nThe core feature of build2docker is to fetch a git repository (from GitHub or locally),\nbuild a container image based on the specifications found in the repository &\noptionally launch the container that you can use to explore the repository.\n\n**Note that Docker needs to be running on your machine for this to work.**\n\nExample:\n\n```bash\njupyter-build2docker https://github.com/norvig/pytudes\n```\n\nAfter building (it might take a while!), it should output in your terminal\nsomething like:\n\n```bash\n Copy/paste this URL into your browser when you connect for the first time,\n to login with a token:\n http://0.0.0.0:36511/?token=f94f8fabb92e22f5bfab116c382b4707fc2cade56ad1ace0\n```\n\nIf you copy paste that URL into your browser you will see a Jupyter Notebook\nwith the contents of the repository you had just built!\n\nFor more information on how to use `build2docker`, see the\n[usage guide](http://build2docker.readthedocs.io/en/latest/usage.html).\n\n## Repository specifications\n\nBuild2Docker looks for configuration files in the source repository to\ndetermine how the Docker image should be built. For a list of the configuration\nfiles that `build2docker` can use, see the\n[complete list of configuration files](https://build2docker.readthedocs.io/en/latest/config_files.html).\n\nThe philosophy of build2docker is inspired by\n[Heroku Build Packs](https://devcenter.heroku.com/articles/buildpacks).\n\n## Docker Image\n\nBuild2Docker can be run inside a Docker container if access to the Docker Daemon is provided, for example see [BinderHub](https://github.com/jupyterhub/binderhub). Docker images are [published to quay.io](https://quay.io/repository/khulnasoft/build2docker?tab=tags). The old [Docker Hub image](https://hub.docker.com/r/khulnasoft/build2docker) is no longer supported.\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "Build2docker: Turn code repositories into Jupyter enabled Docker Images",
"version": "2024.9.0",
"project_urls": {
"Documentation": "https://build2docker.readthedocs.io",
"Funding": "https://jupyter.org/about",
"Homepage": "https://build2docker.readthedocs.io/en/latest/",
"Source": "https://github.com/khulnasoft/build2docker/",
"Tracker": "https://github.com/khulnasoft/build2docker/issues"
},
"split_keywords": [
"reproducible",
"science",
"environments",
"docker"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1c664d31c6107334b6a31715197b714b550d88d0dff29f357643db04310e4190",
"md5": "006951ee054c164e28f362512279fc4a",
"sha256": "0477447098be59d4280892edcb828a38b212ff2d6d8ea7eaadbae07a4398b44b"
},
"downloads": -1,
"filename": "jupyter_build2docker-2024.9.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "006951ee054c164e28f362512279fc4a",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.6",
"size": 188468,
"upload_time": "2024-07-10T01:45:05",
"upload_time_iso_8601": "2024-07-10T01:45:05.157106Z",
"url": "https://files.pythonhosted.org/packages/1c/66/4d31c6107334b6a31715197b714b550d88d0dff29f357643db04310e4190/jupyter_build2docker-2024.9.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a40b1344e073a052bf9a6601ede92fb10650df409b804cd50a864f4381d385d2",
"md5": "2a9cac8982383101208f1672f7dfb6f9",
"sha256": "d2c7a72f5b9f97a2d4f10228f943d232362bd842f57334001101644d0974f5cd"
},
"downloads": -1,
"filename": "jupyter_build2docker-2024.9.0.tar.gz",
"has_sig": false,
"md5_digest": "2a9cac8982383101208f1672f7dfb6f9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 145469,
"upload_time": "2024-07-10T01:45:07",
"upload_time_iso_8601": "2024-07-10T01:45:07.199085Z",
"url": "https://files.pythonhosted.org/packages/a4/0b/1344e073a052bf9a6601ede92fb10650df409b804cd50a864f4381d385d2/jupyter_build2docker-2024.9.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-10 01:45:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "khulnasoft",
"github_project": "build2docker",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "jupyter-build2docker"
}
JSON
