Skip to content
This repository has been archived by the owner on Aug 8, 2023. It is now read-only.

Commit

Permalink
Merge branch 'master' into add-user-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
saulshanabrook committed Nov 11, 2019
2 parents d2e12e8 + 9347c47 commit a7125af
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 10 deletions.
35 changes: 26 additions & 9 deletions README.md
@@ -1,22 +1,37 @@
# JupyterLab Data Explorer

![Stability Experimental][badge-stability] [![Binder][badge-binder]][binder] [![npm][badge-npm-version-dataregistry-extension]][npm-package-dataregistry-extension] [![npm][badge-npm-version-dataregistry]][npm-package-dataregistry]
![Stability Experimental][badge-stability] [![npm][badge-npm-version-dataregistry-extension]][npm-package-dataregistry-extension] [![npm][badge-npm-version-dataregistry]][npm-package-dataregistry]

```bash
jupyter labextension install @jupyterlab/dataregistry-extension
```
To experiment with the extension in a live notebook environment,

- latest release (stable version): [![Binder (stable)][badge-binder]][binder-stable]
- latest master (bleeding edge): [![Binder (latest)][badge-binder]][binder-master]

## Overview

- Bring any data type you can imagine! **Extensible** and **type safe** data registry system.
- Register **conversions** between the different data types.
- Data changing on you? Use [`RxJS` **observables**][rxjs] to represent data over time.
- Have a new way to look at your data? Create **React** or **Phosphor** components to view a certain type.
- Built in data **explorer UI** to find and use available datasets.
- Built-in data **explorer UI** to find and use available datasets.
- Dataset in your dataset? Use the **nested** datatype.
- Building another data centric application? Use the **`@jupyterlab/dataregistry`** package which has no JupyterLab dependencies.
- Building another data centric application? Use the [`@jupyterlab/dataregistry`][npm-package-dataregistry] package which can be used independently of [JupyterLab][jupyterlab].
- Check out the project vision in the ["Press Release from the Future"](./press_release.md)!

![](https://user-images.githubusercontent.com/1186124/59360085-85becf80-8cfd-11e9-8fc8-98d8a7b83934.png)

## Prerequisites

When used as a [JupyterLab][jupyterlab] extension,

- [JupyterLab][jupyterlab] (version >= 1.0.0)

## Installation

```bash
$ jupyter labextension install @jupyterlab/dataregistry-extension
```

## Usage

[Usage docs](./docs/usage.md)
Expand All @@ -31,21 +46,23 @@ We try to keep the current issues relevant and matched to relevant milestones.

### Third Party Extenson

You can either add support in this repo or by creating a new JupyterLab extension that depends on the `IRegistry` exposed by this extension. You can access a `Registry`, which you can use to add your own converter.
You can either add support by adding a new converter to this repository or creating a new [JupyterLab][jupyterlab] extension that depends on the `IRegistry` exposed by this extension. You can access a `Registry`, which you can use to add your own converter.

It might also be useful to view the existing data types by looking at the source code in this repo and by using the debugger. You can open this in JupyterLab by looking for the "Data Debugger" command:
It might also be useful to view the existing data types by looking at the source code in this repository and by using the debugger. You can open this in [JupyterLab][jupyterlab] by looking for the "Data Debugger" command:

![](./docs/img/debugger.png)

<!-- links -->

[badge-stability]: https://img.shields.io/badge/stability-experimental-red.svg
[badge-binder]: https://mybinder.org/badge_logo.svg
[binder]: https://mybinder.org/v2/gh/jupyterlab/jupyterlab-data-explorer/4d004f8c8be28111d988f0c62bccd859cef9236e?urlpath=lab/tree/notebooks/Table.ipynb
[binder-stable]: https://mybinder.org/v2/gh/jupyterlab/jupyterlab-data-explorer/4a47ff159818159450814b33b0b33f2221c223a5?urlpath=lab%2Ftree%2Fnotebooks%2Fdemo.ipynb
[binder-master]: https://mybinder.org/v2/gh/jupyterlab/jupyterlab-data-explorer/master?urlpath=lab%2Ftree%2Fnotebooks%2Fdemo.ipynb
[badge-npm-version-dataregistry-extension]: https://img.shields.io/npm/v/@jupyterlab/dataregistry-extension?label=%40jupyterlab%2Fdataregistry-extension&style=flat
[npm-package-dataregistry-extension]: https://www.npmjs.com/package/@jupyterlab/dataregistry-extension
[badge-npm-version-dataregistry]: https://img.shields.io/npm/v/@jupyterlab/dataregistry?label=%40jupyterlab%2Fdataregistry&style=flat
[npm-package-dataregistry]: https://www.npmjs.com/package/@jupyterlab/dataregistry
[jupyterlab]: https://github.com/jupyterlab/jupyterlab
[rxjs]: https://rxjs.dev/
[nteract-data-explorer]: https://github.com/nteract/nteract/tree/master/packages/data-explorer

Expand Down
1 change: 0 additions & 1 deletion binder/postBuild
Expand Up @@ -13,4 +13,3 @@ jlpm run registry &
jlpm run registry:init
jlpm run build
jupyter lab build || (jlpm run build:jupyter:remediate && jupyter lab build)
jupyter lab build
File renamed without changes.
File renamed without changes.

0 comments on commit a7125af

Please sign in to comment.