repo2docker/docs/source/install.rst

.. _install:

Installing ``repo2docker``
==========================

1. Install `Docker <https://www.docker.com>`_ as it is required to build Docker images.

2. We recommend installing ``repo2docker`` with the ``pip`` tool::

    python3 -m pip install jupyter-repo2docker

For infomation on using ``repo2docker``, see :ref:`usage`.

Installing repo2docker from source code
---------------------------------------

Alternatively, you can install repo2docker from source,
i.e. if you are contributing back to this project::

  git clone https://github.com/jupyter/repo2docker.git
  cd repo2docker
  pip install -e .

That's it! For information on using ``repo2docker``, see
:ref:`usage`.