Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Jupyterlab plugin install docs #308

Merged
merged 1 commit into from
Nov 14, 2018
Merged

Added Jupyterlab plugin install docs #308

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,3 +75,26 @@ Doing so is quite a bit more complex than a standard pure Javascript NPM
package, so if you're not looking to hack on Perspective itself, you are likely
better off choosing the CDN or NPM methods above. See the
[developer docs](development.html) for details.

## Jupyterlab

Perspective comes bundled with a complete Jupyterlab plugin which can be
accessed from Python via the complementary
[`perspective-python`](https://github.com/timkpaine/perspective-python)
package. `perspective-python` implements mostly the same API as
`<perspective-viewer>`, and works with static `pandas.DataFrame` objects as well
as streaming incremental updates via the `update()` method (as in Javascript).

<img src="https://jpmorganchase.github.io/perspective/img/jupyterlab.png"></img>

You'll need to install both to utilize Perspective from Python in Jupyterlab.
Assuming you've already installed the latter 3, you can install the Perspective
plugin as below, or follow the install from source instructions from the
`perspective-python`
[documentation](https://perspective-python.readthedocs.io/en/latest/index.html).

```bash
pip install perspective-python
jupyter labextension install @jpmorganchase/perspective-jupyterlab
```