Metadata-Version: 2.1
Name: aicrowd-repo2docker
Version: 0.11.0
Summary: Repo2docker: Turn code repositories into Jupyter enabled Docker Images
Home-page: https://repo2docker.readthedocs.io/en/latest/
Author: Project Jupyter Contributors
Author-email: jupyter@googlegroups.com
License: BSD
Project-URL: Documentation, https://repo2docker.readthedocs.io
Project-URL: Funding, https://jupyter.org/about
Project-URL: Source, https://github.com/jupyterhub/repo2docker/
Project-URL: Tracker, https://github.com/jupyterhub/repo2docker/issues
Description: # <a href="https://github.com/jupyterhub/repo2docker"><img src="https://raw.githubusercontent.com/jupyterhub/repo2docker/3fa7444fca6ae2b51e590cbc9d83baf92738ca2a/docs/source/_static/images/repo2docker.png" height="48px" /> repo2docker</a>
        
        [![Deploy Status](https://travis-ci.org/jupyterhub/repo2docker.svg?branch=master)](https://travis-ci.org/jupyterhub/repo2docker)
        [![Build Status](https://github.com/jupyterhub/repo2docker/workflows/Continuous%20Integration/badge.svg)](https://github.com/jupyterhub/repo2docker/actions)
        [![Documentation Status](https://readthedocs.org/projects/repo2docker/badge/?version=latest)](http://repo2docker.readthedocs.io/en/latest/?badge=latest)
        [![Contribute](https://img.shields.io/badge/I_want_to_contribute!-grey?logo=jupyter)](https://repo2docker.readthedocs.io/en/latest/contributing/contributing.html)
        
        `repo2docker` fetches a git repository and builds a container image based on
        the configuration files found in the repository.
        
        See the [repo2docker documentation](http://repo2docker.readthedocs.io)
        for more information on using repo2docker.
        
        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
        repo2docker.
        
        
        ## Using repo2docker
        ### 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://repo2docker.readthedocs.io/en/latest/install.html#note-about-windows-support)
        
        ### Installation
        
        This a quick guide to installing `repo2docker`, see our documentation for [a full guide](https://repo2docker.readthedocs.io/en/latest/install.html).
        
        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](http://repo2docker.readthedocs.io/en/latest/usage.html).
        
        
        ## 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](https://repo2docker.readthedocs.io/en/latest/config_files.html).
        
        The philosophy of repo2docker is inspired by
        [Heroku Build Packs](https://devcenter.heroku.com/articles/buildpacks).
        
Keywords: reproducible science environments docker
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.6
Description-Content-Type: text/markdown
