Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jupyter/dashboards

[RETIRED] See Voilà as a supported replacement
https://github.com/jupyter/dashboards

dashboard jupyter jupyter-notebook

Last synced: 3 months ago
JSON representation

[RETIRED] See Voilà as a supported replacement

Awesome Lists containing this project

README

        

# [RETIRED] Jupyter Dashboards - Layout Extension

This project has been retired and replaced by incorporating the [Voilà ecosystem of dashboarding tools into Project Jupyter](https://github.com/voila-dashboards). See the [Jupyter blog](https://blog.jupyter.org/and-voil%C3%A0-f6a2c08a4a93) [posts](https://blog.jupyter.org/a-gallery-of-voil%C3%A0-examples-a2ce7ef99130?source=collection_home---6------10-----------------------) about Voilà and the [proposal to make Voilà part of Jupyter](https://github.com/jupyter/enhancement-proposals/blob/master/voila-incorporation/voila-incorporation.md) for more details. [voila-gridstack](https://github.com/voila-dashboards/voila-gridstack) is an on-going project to support layouts created by this deprecated extension using Voilà.

---

[![Project Status: Inactive – The project has reached a stable, usable state but is no longer being actively developed; support/maintenance will be provided as time allows.](https://www.repostatus.org/badges/latest/inactive.svg)](https://www.repostatus.org/#inactive)
[![PyPI version](https://badge.fury.io/py/jupyter_dashboards.svg)](https://badge.fury.io/py/jupyter_dashboards) [![Build Status](https://travis-ci.org/jupyter/dashboards.svg?branch=master)](https://travis-ci.org/jupyter/dashboards) [![Google Group](https://img.shields.io/badge/-Google%20Group-lightgrey.svg)](https://groups.google.com/forum/#!forum/jupyter)

## Overview

The dashboards layout extension is an add-on for Jupyter Notebook. It lets you
arrange your notebook outputs (text, plots, widgets, ...) in grid- or
report-like layouts. It saves information about your layouts in your notebook
document. Other people with the extension can open your notebook and view your
layouts.

![Dashboard layout screenshot](docs/source/_static/dashboards_intro.png)

For a sample of what's possible with the dashboard layout extension, have a look at the [demo dashboard-notebooks](etc/notebooks) in this repository.

## Installation

Detailed installation instructions appear in the [Getting started
page](http://jupyter-dashboards-layout.readthedocs.io/en/latest/getting-started.html)
of the project docs. Here's a quickstart using pip or conda:

```bash
# install using pip from pypi and then activate the extension
pip install jupyter_dashboards
jupyter dashboards quick-setup --sys-prefix

# install using conda from conda-forge, no activation required
conda install jupyter_dashboards -c conda-forge
```

## Contributing

The [Development
page](http://jupyter-dashboards-layout.readthedocs.io/en/latest/development.html)
includes information about setting up a dev environment and typical dev tasks.