Merge pull request #225 from consideRatio/pr/gha-migration

GitHub Actions migration

Author: yuvipanda

.github/workflows/test.yaml

@@ -0,0 +1,62 @@
+# This is a GitHub workflow defining a set of jobs with a set of steps.
+# ref: https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions
+#
+name: Test
+
+# Trigger the workflow's on all PRs but only on pushed tags or commits to
+# main/master branch to avoid PRs developed in a GitHub fork's dedicated branch
+# to trigger.
+on:
+  pull_request:
+  push:
+    branches:
+    tags:
+  workflow_dispatch:
+
+defaults:
+  run:
+    # Declare bash be used by default in this workflow's "run" steps.
+    #
+    # NOTE: bash will by default run with:
+    #   --noprofile: Ignore ~/.profile etc.
+    #   --norc:      Ignore ~/.bashrc etc.
+    #   -e:          Exit directly on errors
+    #   -o pipefail: Don't mask errors from a command piped into another command
+    shell: bash
+
+jobs:
+  test:
+    runs-on: ubuntu-20.04
+
+    strategy:
+      # Keep running even if one variation of the job fail
+      fail-fast: false
+      matrix:
+        # We run this job multiple times with different parameterization
+        # specified below, these parameters have no meaning on their own and
+        # gain meaning on how job steps use them.
+        include:
+          - python: 3.5
+          - python: 3.6
+          - python: 3.7
+          - python: 3.8
+          - python: 3.9
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: "${{ matrix.python }}"
+
+      - name: Install Python dependencies
+        run: |
+          pip install --upgrade pip
+          pip install .
+          pip install pytest
+          pip freeze
+
+      - name: Run tests
+        run: |
+          JUPYTER_TOKEN=secret jupyter-notebook --config=./tests/resources/jupyter_server_config.py &
+          sleep 5
+          pytest --verbose --color=yes

.travis.yml

@@ -0,0 +1,107 @@
+# 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
+```

README.md

@@ -1,6 +1,9 @@
 import setuptools
 from glob import glob
 
+with open("README.md") as f:
+    readme = f.read()
+
 setuptools.setup(
     name="jupyter-server-proxy",
     version='1.5.2',
@@ -9,6 +12,8 @@
     author_email="[email protected]",
     license="BSD 3-Clause",
     description="Jupyter server extension to supervise and proxy web services",
+    long_description=readme,
+    long_description_content_type="text/markdown",
     packages=setuptools.find_packages(),
     install_requires=['notebook', 'simpervisor>=0.2', 'aiohttp'],
     python_requires='>=3.5',