repo2docker/README.md

84 wiersze
3.1 KiB
Markdown
Czysty Zwykły widok Historia

# <a href="https://github.com/jupyter/repo2docker"><img src="https://raw.githubusercontent.com/jupyter/repo2docker/3fa7444fca6ae2b51e590cbc9d83baf92738ca2a/docs/source/_static/images/repo2docker.png" height="48px" /> repo2docker</a>
2017-10-07 00:43:31 +00:00
[![Build Status](https://travis-ci.org/jupyter/repo2docker.svg?branch=master)](https://travis-ci.org/jupyter/repo2docker)
2017-10-23 16:10:56 +00:00
[![Documentation Status](https://readthedocs.org/projects/repo2docker/badge/?version=latest)](http://repo2docker.readthedocs.io/en/latest/?badge=latest)
2017-10-07 00:43:31 +00:00
2018-10-09 08:12:56 +00:00
`repo2docker` fetches a git repository and builds a container image based on
the configuration files found in the repository.
2017-12-07 18:50:46 +00:00
See the [repo2docker documentation](http://repo2docker.readthedocs.io)
2018-11-06 07:50:25 +00:00
for more information on using repo2docker.
2017-10-07 00:43:31 +00:00
2018-10-09 08:12:56 +00:00
See the [contributing guide](CONTRIBUTING.md) for information on contributing to
repo2docker.
2018-11-08 18:06:42 +00:00
See [our roadmap](https://repo2docker.readthedocs.io/en/latest/contributing/roadmap.html)
to learn about where the project is heading.
2018-10-09 08:12:56 +00:00
## Using repo2docker
### Prerequisites
2017-10-07 00:43:31 +00:00
1. Docker to build & run the repositories. The [community edition](https://store.docker.com/search?type=edition&offering=community)
is recommended.
2. Python 3.4+.
Supported on Linux and macOS. [See documentation note about Windows support.](http://repo2docker.readthedocs.io/en/latest/install.html#note-about-windows-support)
2018-10-09 08:12:56 +00:00
### Installation
This a quick guide to installing `repo2docker`, see our documentation for [a full guide](https://repo2docker.readthedocs.io/en/latest/install.html).
2017-10-07 00:43:31 +00:00
2018-10-09 08:12:56 +00:00
To install from PyPI:
2017-10-07 00:43:31 +00:00
```bash
pip install jupyter-repo2docker
```
To install from source:
2017-10-07 00:43:31 +00:00
```bash
git clone https://github.com/jupyter/repo2docker.git
cd repo2docker
pip install -e .
2017-10-07 00:43:31 +00:00
```
2018-10-09 08:12:56 +00:00
### Usage
2017-10-07 00:43:31 +00:00
2018-10-09 08:12:56 +00:00
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 &
2018-10-09 08:12:56 +00:00
optionally launch the container that you can use to explore the repository.
2017-10-07 00:43:31 +00:00
**Note that Docker needs to be running on your machine for this to work.**
Example:
```bash
jupyter-repo2docker https://github.com/norvig/pytudes
2017-10-07 00:43:31 +00:00
```
After building (it might take a while!), it should output in your terminal
something like:
2017-10-07 00:43:31 +00:00
```bash
2017-10-07 00:43:31 +00:00
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!
2017-10-07 00:43:31 +00:00
2017-12-07 18:50:46 +00:00
For more information on how to use ``repo2docker``, see the
[usage guide](http://repo2docker.readthedocs.io/en/latest/usage.html).
2017-10-07 00:43:31 +00:00
2018-10-09 08:12:56 +00:00
2017-10-07 00:43:31 +00:00
## Repository specifications
2017-12-08 19:53:15 +00:00
Repo2Docker looks for configuration files in the source repository to
2018-10-09 08:12:56 +00:00
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](https://repo2docker.readthedocs.io/en/latest/config_files.html).
2017-10-07 00:43:31 +00:00
2018-10-09 08:12:56 +00:00
The philosophy of repo2docker is inspired by
[Heroku Build Packs](https://devcenter.heroku.com/articles/buildpacks).