• This repository has been archived on 27/Oct/2019
  • Stars
    star
    181
  • Rank 212,110 (Top 5 %)
  • Language
    JavaScript
  • License
    Other
  • Created almost 9 years ago
  • Updated about 7 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

[RETIRED] Server that runs and renders Jupyter notebooks as interactive dashboards

npm version Build Status Google Group

[RETIRED] Jupyter Dashboards Server

This project has been retired. See the proposal to move the project to jupyter-attic, announcement of the proposal on the mailing list, and Steering Council vote on the proposal PR for more information.


A NodeJS application that can display Jupyter notebooks as dynamic dashboards outside of the Jupyter Notebook server.

Dashboards server screenshot

The Jupyter Incubator Dashboards effort covers:

  1. Arranging notebook outputs in a grid- or report-like layout
  2. Bundling notebooks and associated assets for deployment as dashboards
  3. Serving notebook-defined dashboards as standalone web apps

This repository focuses on (3) above, while jupyter-incubator/dashboards handles (1) and jupyter-incubator/dashboards_bundlers implements (2).

See https://github.com/jupyter-incubator/dashboards/wiki for an overview of the entire dashboard incubation effort.

What it Gives You

  • Ability to run some Jupyter notebooks as standalone dashboard applications [1]
  • Ability to navigate a list of multiple notebooks and select one to run as a dashboard
  • Optional shared login to secure access to the dashboard server
  • Ability to add custom authentication mechanisms using the Passport middleware for Node.js
  • An API for POSTing notebooks to the server at runtime with optional authentication (/_api/notebooks)

The qualification in [1] stems from the fact that supporting one-click deploy of notebooks with arbitrary JavaScript and kernel dependencies is a "Really Hard Problem." We've invested effort in getting these dashboard, visualization, and widget libraries working in the dashboard server.

  • jupyter_dashboards 0.6.x
  • jupyter_dashboards_bundlers 0.8.x
  • ipywidgets 5.2.x
  • jupyter_declarativewidgets 0.6.x
  • matplotlib 1.5.x
  • Bokeh 0.11.x
  • Plotly 1.9.x

If you try another library and find that it does not work in the dashboard server, see the wiki page about Widget Support below for steps you might take to resolve the problem.

Install it

Install Node 5.x and npm 3.5.x. Use npm to install the jupyter-dashboards-server package.

npm install -g jupyter-dashboards-server

You can then run the dashboard server from the command line. See the next section about how to install and configure the other prerequisite components.

# shows a list of all nconf options
jupyter-dashboards-server --help

# runs the server pointing to a public kernel gateway
jupyter-dashboards-server --KERNEL_GATEWAY_URL=http://my.gateway.com/

# runs the server pointing to a kernel gateway that requires token auth
export KG_AUTH_TOKEN='somesecretinenvironment'
jupyter-dashboards-server --KERNEL_GATEWAY_URL=http://my.gateway.com/

Run It

The dashboard server is meant to support the layout-bundler-deploy workflow described on the project overview page. This workflow requires multiple components working in concert.

Minimal dashboard app deployment diagram

To bring all of these pieces together, you can start with the recipes in the jupyter-incubator/dashboards_setup repo. (We'll gladly take PRs that reduce the complexity of getting everything set up!)

Alternatively, you can clone this git repository and build the Docker images we use for development in order to run the demos in etc/notebooks. After setting up Docker (e.g. using docker-machine), run the following and then visit http://<your docker host ip>:3000.

make build
make examples
make demo-container

Run Behind a Proxy

The dashboards server can be run behind a reverse proxy. In order to do so, you will need to set the following options as command line args or in environment vars.

  • TRUST_PROXY - The simple option is to just set this to true. However, if you require further configuration on which requests to trust, this option can also take values as specified by the Express documentation.
  • BASE_URL - Specify the base URL (prefix) at which the dashboards server will run. The server supports two options here: passing the prefix along with the request or stripping the prefix off the request.

For example:

# allow proxying of "http://proxy_host/db/..." to "http://dashboards_host/db/..."
jupyter-dashboards-server --TRUST_PROXY=true --BASE_URL=/db --KERNEL_GATEWAY_URL=http://my.gateway.com/

# allow proxying of "http://proxy_host/db/..." to "http://dashboards_host/..."
jupyter-dashboards-server --TRUST_PROXY=true --BASE_URL='[/db]' --KERNEL_GATEWAY_URL=http://my.gateway.com/

Develop It

To setup a development environment, install these minimum versions on your host machine.

  • Node 5.5.0
  • npm 3.5.3
  • gulp 3.9.0
  • Docker 1.9.1

With these installed, you can use the make dev-* targets. Run make help to see the full gamut of targets and options. See the next few sections for the most common patterns.

Setup

# re-run if the Dockerfile.kernel changes
make kernel-gateway-image
# re-run if package.json changes
make dev-install
# run if you want to try the preliminary jupyter-incubator/declarativewidgets support
make examples

Dashboard Server w/ Auto Restart

# uses gulp:watch to restart on any changes
make dev
# mac shortcut for visiting URL in a browser
open http://127.0.0.1:3000

Dashboard Server w/ Auto Restart and Debug Console Logging

make dev-logging
# mac shortcut for visiting URL in a browser
open http://127.0.0.1:3000

Dashboard Server w/ Auto Restart and Remote Debugging

npm install -g node-inspector
make dev-debug
# a browser tab should open with the debugger visible
# refresh if it errors: the server might not be running yet

Dashboard Server w/ Auto Restart and Form Auth

make dev USERNAME=admin PASSWORD=password
# mac shortcut for visiting URL in a browser
open http://127.0.0.1:3000

See the Authentication wiki page for information about configuring alternative authentication mechanisms.

Dashboard Server w/ Auto Restart and Self-Signed HTTPS Certificate

make certs
make dev HTTPS_KEY_FILE=certs/server.pem HTTPS_CERT_FILE=certs/server.pem
# mac shortcut for visiting URL in a browser
open https://127.0.0.1:3001

Dashboard Server Tests

# unit tests
make test
# backend integration tests
make integration-test
# installation tests
make install-test

Technical Details

See the wiki attached to this project for additional technical details including the server API, authentication plugins, adding support for new widgets, and more.

More Repositories

1

jupyter

Jupyter metapackage for installation, docs and chat
Python
14,886
star
2

notebook

Jupyter Interactive Notebook
Jupyter Notebook
11,528
star
3

docker-stacks

Ready-to-run Docker images containing Jupyter applications
Python
7,890
star
4

nbdime

Tools for diffing and merging of Jupyter notebooks.
TypeScript
2,649
star
5

nbviewer

nbconvert as a web service: Render Jupyter Notebooks as static web pages
Python
2,204
star
6

nbconvert

Jupyter Notebook Conversion
Python
1,707
star
7

nbgrader

A system for assigning and grading notebooks
Python
1,274
star
8

dashboards

[RETIRED] See Voilà as a supported replacement
Jupyter Notebook
984
star
9

colaboratory

[deprecated] Jupyter CoLaboratory, goto google colab now
JavaScript
740
star
10

tmpnb

Creates temporary Jupyter Notebook servers using Docker containers. [DEPRECATED - See BinderHub project]
JavaScript
528
star
11

jupyter-drive

Google drive for jupyter notebooks
TypeScript
418
star
12

qtconsole

Jupyter Qt Console
Python
407
star
13

jupyter_client

Jupyter protocol client APIs
Python
379
star
14

terminado

Terminals served by tornado websockets
Python
366
star
15

atom-notebook

[Deprecated] Jupyter Notebook, but inside Atom.
JavaScript
306
star
16

help

✨ Need some help or have some questions? Please visit our Discourse page.
291
star
17

nbformat

Reference implementation of the Jupyter Notebook format
Python
259
star
18

jupyter_console

Jupyter Terminal Console
Python
249
star
19

jupyter_core

Core Jupyter functionality
Python
195
star
20

docker-notebook

Docker containers for the IPython notebook (+SciPy Stack)
Shell
188
star
21

jupyter-sphinx

Sphinx extension for rendering of Jupyter interactive widgets.
Python
186
star
22

jupyter.github.io

Project Jupyter's home on the World Wide Web
HTML
177
star
23

nbconvert-examples

Examples that illustrate how nbconvert can be used
Jupyter Notebook
164
star
24

kernel_gateway_demos

Demos associated with the kernel gateway incubator project
Jupyter Notebook
152
star
25

nbclient

A client library for executing notebooks. Formally nbconvert's ExecutePreprocessor
Python
149
star
26

declarativewidgets

[RETIRED] Jupyter Declarative Widget Extension
HTML
120
star
27

enhancement-proposals

Enhancement proposals for the Jupyter Ecosystem
Python
115
star
28

papyri

Python
84
star
29

roadmap

Master roadmap for Project Jupyter
84
star
30

governance

The governance process and model for Project Jupyter
Python
82
star
31

design

Design related materials for Project Jupyter
HTML
80
star
32

dashboards_bundlers

[RETIRED] Converts a notebook to a dashboard and deploys it / downloads it
Python
79
star
33

docker-demo-images

Demo images for use in try.jupyter.org and tmpnb.org
Jupyter Notebook
75
star
34

scipy-advanced-tutorial

Advance Tutorial For SciPy
JavaScript
75
star
35

nbclassic

Jupyter Notebook as a Jupyter Server extension
JavaScript
74
star
36

nb2kg

Python
73
star
37

services

This repository is deprecated. It has been moved to https://github.com/jupyterlab/jupyterlab as a sub-package
TypeScript
70
star
38

accessibility

A repository for ongoing work around making Jupyter's software accessible and inclusive
Python
65
star
39

jupyter_kernel_test

A tool for testing Jupyter kernels
Python
62
star
40

jupyter-packaging

Tools to help build and install Jupyter Python packages
Python
62
star
41

nbmanager

View and stop running IPython notebook servers
Python
51
star
42

telemetry

Configurable event-logging for Jupyter applications and extensions.
Python
50
star
43

ngcm-tutorial

Materials for the IPython/Jupyter workshop at the NGCM Summer Academy, at Southampton University, Boldrewood campus.
Jupyter Notebook
46
star
44

jupyter-js-notebook

JupyterLab notebook
TypeScript
46
star
45

debugger

Research and explorations for an interactive debugger for Jupyter
41
star
46

echo_kernel

A simple example kernel for Jupyter
Python
39
star
47

ipython-py3k

**DO NOT USE THIS REPOSITORY AT ALL** This repo has been merged into the main IPython one that now contains Python 3 support. This is kept only as a reference to developers.
Python
34
star
48

jsplugins

JavaScript Plugins for the IPython Notebook
32
star
49

jupyterhub-2016-workshop

Materials for an online mini-workshop around JupyterHub use cases, held July 22nd, 2016
31
star
50

dashboards_setup

[RETIRED] Recipes for setting up components related to the incubating dashboards effort
Jupyter Notebook
28
star
51

testpath

Test utilities for Python code working with files and commands
Python
27
star
52

strata-sv-2015-tutorial

Strata Silicon Valley 2015 Tutorial
Python
24
star
53

jupyter-js-plugins

TypeScript
23
star
54

surveys

Surveys and datasets collected by Project Jupyter
Jupyter Notebook
23
star
55

jupyter-sphinx-theme

A Sphinx theme for Jupyter and IPython documentation
HTML
22
star
56

jvm-repr

API for converting JVM objects to representations by MIME type, for the Jupyter ecosystem.
Java
22
star
57

notebook-research

Research on the usage of Jupyter notebooks
Jupyter Notebook
20
star
58

security

19
star
59

tutorial-dashboards-declarativewidgets

Materials for the PyData Carolinas 2016 tutorial, Turning Jupyter Notebooks into Data Applications
Jupyter Notebook
19
star
60

tmpnb-deploy

Deploying tmpnb nodes
Python
18
star
61

jupyterlab_json

This repository is deprecated. The extension has moved to https://github.com/jupyterlab/jupyter-renderers
JavaScript
16
star
62

kernels

Kernel testing and listing infrastructure
Python
16
star
63

mozfest15-training

Notebooks for Jupyter training session at Mozfest 2015
Jupyter Notebook
13
star
64

newsletter

A repo for collecting content for the Jupyter Newsletter
Jupyter Notebook
13
star
65

jupyterlab_geojson

This repository is deprecated. The extension has moved to https://github.com/jupyterlab/jupyter-renderers
JavaScript
13
star
66

tmpnb-redirector

Simple HTTP redirector for tmpnb nodes
Python
12
star
67

nature-demo

Materials for the November 2014 Nature Article
Jupyter Notebook
12
star
68

extension-builder

This repository is deprecated.
TypeScript
12
star
69

jupyter_events

Configurable event system for Jupyter applications and extensions.
Python
11
star
70

phosphor-notebook

Phosphor-based jupyter notebook
TypeScript
11
star
71

ipython-components

third-party javascript dependencies of IPython
JavaScript
11
star
72

try.jupyter.org

Try Jupyter!
HTML
10
star
73

jupyter-js-ui

TypeScript
10
star
74

jupyter-js-output-area

DEPRECATED: Javascript APIs for Jupyter output areas
TypeScript
10
star
75

cookiecutter-docker-stacks

Cookiecutter for community-maintained Jupyter Docker images
Python
10
star
76

ideas

A place for the Jupyter community to connect on ideas
9
star
77

kernel_gateway_bundlers

Converts a notebook to a kernel gateway microservice bundle for download
Python
8
star
78

jupyter_markdown

Documentation and tests related to Jupyter's Markdown syntax
Jupyter Notebook
8
star
79

try-jupyter

A JupyterLite deployment to try JupyterLab, Jupyter Notebook and IPython in the browser
Jupyter Notebook
8
star
80

talks

A collection of talks about Jupyter and IPython projects
Jupyter Notebook
8
star
81

jvm-magics

A plugin system for magic function implementations across JVM kernels.
Java
7
star
82

cdn.jupyter.org

Assets and layout for cdn.jupyter.org
Python
7
star
83

jupyter-js-utils

JavaScript utilities for the Jupyter frontend
TypeScript
6
star
84

jupyter_logger

Allows you to log Jupyter notebook user events anonymously.
TypeScript
6
star
85

jupyter-js-filebrowser

DEPRECATED: This code was copied into https://github.com/jupyter/jupyter-js-ui
TypeScript
5
star
86

notebook_shim

A shim layer for notebook traits and config
Python
5
star
87

jupyter-sprints

Resources for running a sprint
HTML
5
star
88

nbcache

Notebook Caching layer in Docker
5
star
89

docs-team-compass

Documentation Work Group Discussions
HTML
5
star
90

jupyter-js-input-area

DEPRECATED: Javascript APIs for Jupyter input areas
TypeScript
5
star
91

sphinxcontrib_github_alt

Github roles for Sphinx docs
Python
5
star
92

jupyterhub-carina

[RETIRED] JupyterHub integration with Carina
Python
5
star
93

win-tornado-terminals

Windows terminal backend for tornado
Python
5
star
94

jupyterlab-fasta

DEPRECATED: Moved to https://github.com/jupyterlab/jupyter-renderers. A JupyterLab Fasta viewer
TypeScript
5
star
95

spreadsheet

A spreadsheet component for phosphor
JavaScript
5
star
96

jupyter-js-editor

DEPRECATED: This code was copied into https://github.com/jupyter/jupyter-js-notebook
TypeScript
4
star
97

jupyter-communitycalls

📣 Resources for planning and hosting the Jupyter Community Calls
4
star
98

distinguished-contributors

Jupyter Distinguished Contributors
4
star
99

project-mgt

4
star
100

showcase

[RETIRED] A spot to try demos of one or more incubating Jupyter projects in Binder
Makefile
4
star