Enable Binder

README.md

@@ -11,9 +11,9 @@
 | Latest dev release | [![Github tag](https://img.shields.io/github/v/tag/holoviz/panel.svg?label=tag&colorB=11ccbb)](https://github.com/holoviz/panel/tags) [![dev-site](https://img.shields.io/website-up-down-green-red/https/pyviz-dev.github.io/panel.svg?label=dev%20website)](https://pyviz-dev.github.io/panel/) |
 | Latest release | [![Github release](https://img.shields.io/github/release/holoviz/panel.svg?label=tag&colorB=11ccbb)](https://github.com/holoviz/panel/releases) [![PyPI version](https://img.shields.io/pypi/v/panel.svg?colorB=cc77dd)](https://pypi.python.org/pypi/panel) [![panel version](https://img.shields.io/conda/v/pyviz/panel.svg?colorB=4488ff&style=flat)](https://anaconda.org/pyviz/panel) [![conda-forge version](https://img.shields.io/conda/v/conda-forge/panel.svg?label=conda%7Cconda-forge&colorB=4488ff)](https://anaconda.org/conda-forge/panel) [![defaults version](https://img.shields.io/conda/v/anaconda/panel.svg?label=conda%7Cdefaults&style=flat&colorB=4488ff)](https://anaconda.org/anaconda/panel) |
 | Docs | [![gh-pages](https://img.shields.io/github/last-commit/holoviz/panel/gh-pages.svg)](https://github.com/holoviz/panel/tree/gh-pages) [![site](https://img.shields.io/website-up-down-green-red/https/panel.holoviz.org.svg)](https://panel.holoviz.org) |
+| Binder | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/holoviz/panel/binder?urlpath=lab/tree/examples) |
 | Support | [![Discourse](https://img.shields.io/discourse/status?server=https%3A%2F%2Fdiscourse.holoviz.org)](https://discourse.holoviz.org/) |
 
-
 ## What is it?
 
 Panel provides tools for easily composing widgets, plots, tables, and other viewable objects and controls into custom analysis tools, apps, and dashboards. Panel works with visualizations from [Bokeh](https://bokeh.pydata.org), [Matplotlib](https://matplotlib.org/), [HoloViews](https://holoviews.org), and many other Python plotting libraries, making them instantly viewable either individually or when combined with interactive widgets that control them.  Panel works equally well in [Jupyter Notebooks](http://jupyter.org), for creating quick data-exploration tools, or as standalone deployed apps and dashboards, and allows you to easily switch between those contexts as needed.
@@ -50,7 +50,7 @@ Panel can be used in a wide range of development environments:
 
 ### Editor + Server
 
-You can edit your Panel code as a .py file in any text editor, marking the objects you want to render as `.servable()`, then launch a server with `panel serve my_script.py --show` to open a browser tab showing your app or dashboard and backed by a live Python process.
+You can edit your Panel code as a .py file in any text editor, marking the objects you want to render as `.servable()`, then launch a server with `panel serve my_script.py --show` to open a browser tab showing your app or dashboard and backed by a live Python process. If you want the server to automatically reload when you save code changes during development, then you should use `panel serve my_script.py --auto --show`.
 
 ### JupyterLab and Classic notebook
 

binder/apt.txt

@@ -0,0 +1,2 @@
+libgl1-mesa-dev
+xvfb

binder/jupyter-panel-apps-server/jupyter_panel_apps_server.py

@@ -0,0 +1,55 @@
+"""
+Function to configure serving the panel example apps via jupyter-server-proxy.
+"""
+import pathlib
+from glob import glob
+
+ICON_PATH = str((pathlib.Path(__file__).parent / "examples-icon.svg").absolute())
+
+DONT_SERVE = [
+    "examples/gallery/demos/attractors.ipynb",
+    "examples/gallery/demos/gapminders.ipynb",
+    "examples/gallery/demos/glaciers.ipynb",
+    "examples/gallery/demos/nyc_taxi.ipynb",
+    "examples/gallery/demos/portfolio-optimizer.ipynb",
+]
+
+
+def get_apps():
+    return [
+        app
+        for app in glob("examples/gallery/**/*.ipynb", recursive=True)
+        if not app in DONT_SERVE
+    ]
+
+
+def panel_serve_examples():
+    """Returns the jupyter-server-proxy configuration for serving the example notebooks as Panel
+    apps.
+
+    Returns:
+        Dict: The configuration dictionary
+    """
+    apps = get_apps()
+    # See:
+    # https://jupyter-server-proxy.readthedocs.io/en/latest/server-process.html
+    # https://github.com/holoviz/jupyter-panel-proxy/blob/master/panel_server/__init__.py
+    return {
+        "command": [
+            "panel",
+            "serve",
+            *apps,
+            "--allow-websocket-origin=*",
+            "--port",
+            "{port}",
+            "--prefix",
+            "{base_url}panel",
+        ],
+        "absolute_url": True,
+        "timeout": 360,
+        "launcher_entry": {
+            "enabled": True,
+            "title": "Apps",
+            "icon_path": ICON_PATH,
+        },
+    }

binder/jupyter-panel-apps-server/setup.py

@@ -0,0 +1,14 @@
+"""This setup.py will install a package that configures the jupyter-server-proxy to
+panel serve the example notebooks."""
+import setuptools
+
+setuptools.setup(
+    name="jupyter-panel-examples-server",
+    py_modules=["jupyter_panel_apps_server"],
+    entry_points={
+        "jupyter_serverproxy_servers": [
+            "panel = jupyter_panel_apps_server:panel_serve_examples",
+        ]
+    },
+    install_requires=["jupyter-server-proxy", "panel"],
+)