Merge remote-tracking branch 'refs/remotes/origin/main' into main

Author: jhgoebbert

.github/workflows/build.yml

@@ -1,18 +1,20 @@
-name: Python package
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
+name: build
 on:
   push:
-    branches: [ $default-branch ]
+    branches: [ main ]
   pull_request:
-    branches: [ $default-branch ]
+    branches: [ main ]
 
 jobs:
   build:
 
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8]
+        python-version: [3.5, 3.6, 3.7, 3.8]
 
     steps:
     - uses: actions/checkout@v2
@@ -29,7 +31,7 @@ jobs:
       run: |
         # stop the build if there are Python syntax errors or undefined names
         flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-        # exit-zero treats all errors as warnings
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
         flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
     - name: Test with pytest
       run: |

README.md

@@ -1,10 +1,9 @@
+![build](https://github.com/FZJ-JSC/jupyter-xprahtml5-proxy/workflows/build/badge.svg)
+
 # jupyter-xprahtml5-proxy
---------------------------
 Integrate Xpra in your Jupyter environment for an fast, feature-rich and easy to use remote desktop in the browser.
 
 ## Requirements
----------------
-
 - Python 3.6+
 - Jupyter Notebook 6.0+
 - JupyterLab 2.1+
@@ -20,23 +19,19 @@ Best of it. It is fast, fast, fast and comes with a build-in html5 client to all
 [Jupyter-Server-Proxy](https://jupyter-server-proxy.readthedocs.io) lets you run arbitrary external processes (such as Xpra-HTML5) alongside your notebook, and provide authenticated web access to them.
 
 ## Install 
-----------
 
 #### Create and Activate Environment
-
 ```
 virtualenv -p python3 venv
 source venv/bin/activate
 ```
 
 #### Install jupyter-xprahtml5-proxy
-
 ```
 pip install git+https://github.com/FZJ-JSC/jupyter-xprahtml5-proxy.git
 ```
 
 #### Enable jupyter-xprahtml5-proxy Extensions
-
 For Jupyter Classic, activate the jupyter-server-proxy extension:
 ```
 jupyter serverextension enable --sys-prefix jupyter_server_proxy
@@ -49,13 +44,10 @@ jupyter lab build
 ```
 
 #### Start Jupyter Classic or Jupyter Lab
-
 Click on the Xpra icon from the Jupyter Lab Launcher or the Xpra item from the New dropdown in Jupyter Classic.  
 Connect to your database as instructed in the Quickstart section.
 
 ## Configuration
-----------------
-
 This package calls `xpra` with a bunch of settings. Please read the [Xpra manual](https://xpra.org/manual.html) if you want to now the details.  
 You have to modify `setup_xprahtml5()` in `jupyter_xprahtml5/__init__.py` for change.