Skip to content

Latest commit

 

History

History
123 lines (83 loc) · 5.06 KB

README.md

File metadata and controls

123 lines (83 loc) · 5.06 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

JupyterLab 3:

pip install jupyterlab-tabular-data-editor

JupyterLab 2:

jupyter labextension install jupyterlab-tabular-data-editor

Contributing

Development install

Note: You will need NodeJS to build the extension package.

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
# Change directory to the jupyterlab-tabular-data-editor directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm run build

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, the jlpm run build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

jupyter lab build --minimize=False

Uninstall

For JupyterLab 3:

pip uninstall jupyterlab-tabular-data-editor

For JupyterLab 2:

jupyter labextension uninstall jupyterlab-tabular-data-editor