Skip to main content

Adds a spreadsheet viewer to JupyterLab

Project description

JupyterLab Spreadsheet

npm GitHub Supported JLab version CI Build

Image depicting the plugin displaying a simple XLS workbook

Try it out! binder.org

This plugin adds a simple spreadsheet viewer to JupyterLab.

jupyterlab-spreadsheet supports XLS, XLSX, ODS, and CSV files, and allows for basic formatting (such as cell merges). The plugin is in alpha, and doesn't support all features of workbooks (advanced formatting, formulas, etc.).

Refer to the changelog for detailed release notes.

Getting Started

Installing jupyterlab-spreadsheet is easy. Just run the following command:

jupyter labextension install jupyterlab-spreadsheet

If you already have JupyterLab running, you just have to refresh the page.

To open a workbook, navigate to it in the file viewer and double-click on it. To open CSV files in the plugin, right click on the file and use "Open With > Spreadsheet".

Contributing

Contributions are always welcome! jupyterlab-spreadsheet is built off of the 6pac fork of SlickGrid, and uses SheetJS to parse workbooks.

When filing issues, please be sure to give reproduction steps and any relevant error messages or console output. This helps me track down the cause and get a fix out sooner.

Building from Source

To build from sources, clone this repository into a convenient directory and cd into it from a terminal. Then, run the following commands:

yarn install
yarn build
jupyter labextension install .

Then, start JupyterLab as you would normally. File watchers are available via yarn build --watch and jupyter lab --watch.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyterlab_spreadsheet-0.4.2.tar.gz (261.8 kB view hashes)

Uploaded Source

Built Distribution

jupyterlab_spreadsheet-0.4.2-py3-none-any.whl (500.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page