Metadata-Version: 2.1
Name: jupyter-server-proxy
Version: 1.5.2
Summary: Jupyter server extension to supervise and proxy web services
Home-page: https://github.com/jupyterhub/jupyter-server-proxy
Author: Ryan Lovett & Yuvi Panda
Author-email: rylo@berkeley.edu
License: BSD 3-Clause
Description: # Jupyter Server Proxy
        
        [![ReadTheDocs badge](https://img.shields.io/readthedocs/jupyter-server-proxy?logo=read-the-docs)](https://jupyter-server-proxy.readthedocs.io/)
        [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/jupyterhub/jupyter-server-proxy/Test?logo=github)](https://github.com/jupyterhub/jupyter-server-proxy/actions)
        [![PyPI badge](https://img.shields.io/pypi/v/jupyter-server-proxy.svg?logo=pypi)](https://pypi.python.org/pypi/jupyter-server-proxy)
        [![Conda badge](https://img.shields.io/conda/vn/conda-forge/jupyter-server-proxy?logo=conda-forge)](https://anaconda.org/conda-forge/jupyter-server-proxy)
        [![NPM badge](https://img.shields.io/npm/v/@jupyterlab/server-proxy.svg?logo=npm)](https://www.npmjs.com/package/@jupyterlab/server-proxy)
        
        Jupyter Server Proxy lets you run arbitrary external processes (such as
        RStudio, Shiny Server, Syncthing, PostgreSQL, Code Server, etc)
        alongside your notebook server and provide authenticated web access to
        them using a path like `/rstudio` next to others like `/lab`. Alongside
        the python package that provides the main functionality, the JupyterLab
        extension (`@jupyterlab/server-proxy`) provides buttons in the
        JupyterLab launcher window to get to RStudio for example.
        
        **Note:** This project used to be called **nbserverproxy**. As
        nbserverproxy is an older version of jupyter-server-proxy, uninstall
        nbserverproxy before installing jupyter-server-proxy to avoid conflicts.
        
        The primary use cases are:
        
        1.  Use with JupyterHub / Binder to allow launching users into web
            interfaces that have nothing to do with Jupyter - such as RStudio,
            Shiny, or OpenRefine.
        2.  Allow access from frontend javascript (in classic notebook or
            JupyterLab extensions) to access web APIs of other processes running
            locally in a safe manner. This is used by the [JupyterLab
            extension](https://github.com/dask/dask-labextension) for
            [dask](https://dask.org/).
        
        [The documentation](https://jupyter-server-proxy.readthedocs.io/)
        contains information on installation & usage.
        
        ## Install
        
        ### Python package
        
        #### pip
        
        ```
        pip install jupyter-server-proxy
        ```
        
        #### conda
        
        ```
        conda install jupyter-server-proxy -c conda-forge
        ```
        
        ### JupyterLab extension
        
        Note that as the JupyterLab extension only is a graphical interface to
        launch registered applications in the python package, the extension
        requires the python package to be installed.
        
        ```
        jupyter labextension install @jupyterlab/server-proxy
        ```
        
        ## Contributing
        
        ### Python package
        
        ```
        pip install -e .
        
        # explicit install needed with editable mode (-e) jupyter
        jupyter serverextension enable --sys-prefix jupyter_server_proxy
        ```
        
        ### JupyterLab extension
        
        The `jlpm` command is JupyterLab's pinned version of `yarn` that is
        installed with JupyterLab. You may use `yarn` or `npm` instead of `jlpm`
        below.
        
        ```
        cd jupyterlab-server-proxy
        
        # Install dependencies
        jlpm
        
        # Build Typescript source
        jlpm build
        
        # Link your development version of the extension with JupyterLab
        jupyter labextension link .
        
        # Rebuild Typescript source after making changes
        jlpm build
        
        # Rebuild JupyterLab after making any changes
        jupyter lab build
        ```
        
        You can watch the source directory and run JupyterLab in watch mode to
        watch for changes in the extension's source and automatically rebuild
        the extension and application.
        
        ```
        # Watch the source directory in another terminal tab
        jlpm watch
        
        # Run jupyterlab in watch mode in one terminal tab
        jupyter lab --watch
        ```
        
Platform: UNKNOWN
Classifier: Framework :: Jupyter
Requires-Python: >=3.5
Description-Content-Type: text/markdown
