Skip to content

Latest commit

 

History

History
105 lines (72 loc) · 4.01 KB

README.md

File metadata and controls

105 lines (72 loc) · 4.01 KB
Raw

Documentation | Contributing

jupyterlab-tabular-data-editor

Manipulate your tabular data responsively and effectively within JupyterLab.

Binder Github Actions Status Documentation Status npm npm

EXPERIMENTAL: This extension is still in alpha. The API is subject to frequent changes.

Try our extension here!

Read more about the Jupyter Tabular Data Editor Extension in our press release!

  • Note: This is a forward-looking press release and serves to provide a vision of the final product. Not all features in this press release are currently implemented.

Check out our current progress and future plans!

See our progress as of 08/27/2020 from these slides!

Feature Showcase

View Extension Highlights

Launch new files and quickly add rows and columns

gif of launching a new csv file within JupyterLab

Seamlessly rearrange your data table

gif of moving rows and columns within JupyterLab

Insert and remove multiple rows and columns

gif of removing and inserting multiple rows and columns within JupyterLab

Format your data with a click of a button

gif of toggling on a mode that formats data based on data types within JupyterLab

Search and replace with ease

gif of searching and replacing a word within a large file within JupyterLab

Requirements

  • JupyterLab >= 2.0

Install

jupyter labextension install jupyterlab-tabular-data-editor

Contributing

Install

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Move to jupyterlab-tabular-data-editor directory

# Install dependencies
jlpm
# Build Typescript source
jlpm build
# Link your development version of the extension with JupyterLab
jupyter labextension install .
# Rebuild Typescript source after making changes
jlpm build
# Rebuild JupyterLab after making any changes
jupyter lab build

You can watch the source directory and run JupyterLab in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.

# Watch the source directory in another terminal tab
jlpm watch
# Run jupyterlab in watch mode in one terminal tab
jupyter lab --watch

Now every change will be built locally and bundled into JupyterLab. Be sure to refresh your browser page after saving file changes to reload the extension (note: you'll need to wait for webpack to finish, which can take 10s+ at times).

Uninstall

jupyter labextension uninstall jupyterlab-tabular-data-editor