Skip to main content

ContainDS Dashboards extension for JupyterHub

Project description

ContainDS Dashboards for JupyterHub

A Dashboard publishing solution for Data Science teams to share results with decision makers.

Run a private on-premise or cloud-based JupyterHub with extensions to instantly publish Jupyter notebooks or Streamlit apps as user-friendly interactive dashboards to share with non-technical colleagues.

This open source package allows users to create interactive Jupyter notebooks that can be instantly and reliably published as secure interactive Voila web apps.

Any authorised JupyterHub user can view the dashboard.

See full documentation.

How it works

  • Data scientist creates a Jupyter Notebook as normal or uploads Streamlit Python files
  • Data scientist creates a new Dashboard to clone their Jupyter server
  • Other logged-in JupyterHub users see the dashboard in their list
  • Click to launch as a server, using OAuth to gain access
  • User sees a safe user-friendly Voila version of the original notebook

All of this works through a new Dashboards menu item added to JupyterHub's header.

Data scientist creates a Jupyter Notebook as normal

Original Jupyter Notebook

Data scientist creates a new Dashboard to clone their Jupyter server

Create New Dashboard

Other logged-in JupyterHub users see the dashboard in their list

Other User sees dashboard

Click to launch as a server

Dashboard Voila built automatically

Uses OAuth to gain access

Other user OAuths

Other user sees a safe user-friendly Voila version of the original notebook

Voila Dashboard

Or a Streamlit app

Streamlit App

Requirements

Basic requirements:

  • JupyterHub 1.0+
  • Python 3.6+

You should be able to use any authenticator for users to login - for example, corporate Google email sign in, or LDAP.

Your JupyterHub will ideally be using LocalProcessSpawner (the default for standard installs), SystemdSpawner (default for The Littlest JupyterHub), or DockerSpawner.

Support for Kubernetes JupyterHub installations running KubeSpawner is in development - please get in touch with your requirements to help move this forward.

Installation

Full Setup and Installation details are in the documentation.

Contact and Support

This software is an alpha version. Please see LICENSE for details.

Please do get in touch if you try out the package, or would like to but need some support. I would be very interested to find out how it can be used, and to work (without charge) to help you get it running. The project needs feedback in order to develop further!

For more background on this project and our related ContainDS Desktop product, please see our website: containds.com.

Contact support@containds.com with any comments or questions at all. Thank you.

Documentation Status

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cdsdashboards-0.0.16.tar.gz (41.0 kB view hashes)

Uploaded Source

Built Distribution

cdsdashboards-0.0.16-py3-none-any.whl (54.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page