Skip to main content

Jupyterlab extension to browse tabular data files (Parquet, Excel, CSV, TSV) with filtering and sorting capabilities

Project description

jupyterlab_tabular_data_viewer_extension

GitHub Actions npm version PyPI version Total PyPI downloads JL4 Ready

View and browse Parquet, Excel, CSV, and TSV files directly in JupyterLab. Double-click any .parquet, .xlsx, .csv, or .tsv file to open it in a simple, spreadsheet-like table view - no code required. Navigate through your data, inspect values, and explore the structure of your tabular data files with interactive column resizing and advanced filtering capabilities.

Parquet Viewer

Features

Supported File Formats:

  • Parquet files (.parquet) - Full support with efficient columnar data reading
  • Excel files (.xlsx) - Reads first worksheet only. Excel files must be simple tabular data without merged cells, complex formulas, or advanced formatting. Files with these features may not display correctly or fail to load
  • CSV files (.csv) - Comma-separated values with UTF-8 encoding (fallback to latin1)
  • TSV files (.tsv) - Tab-separated values with UTF-8 encoding (fallback to latin1)

Core viewing and navigation:

  • Simple table display showing your data in familiar spreadsheet format
  • Column headers with field names and simplified datatype indicators
  • Interactive column resizing - drag column borders to adjust width independently
  • Progressive loading - starts with 500 rows, automatically loads more as you scroll
  • File statistics (column count, row count, file size) at a glance
  • Fixed status bar remains visible during horizontal scrolling
  • Handles large files efficiently with server-side processing

Advanced filtering and sorting:

  • Column sorting with three-state toggle (ascending, descending, off)
  • Per-column filtering with substring or regex pattern matching
  • Case-insensitive search option
  • Numerical filters supporting comparison operators (>, <, >=, <=, =)
  • Clear filters functionality to reset all active filters
  • Multiple filters work together to narrow down results

Additional features:

  • Right-click context menu on rows to copy data as JSON
  • Configurable file type support via Settings - Enable/disable Parquet, Excel, or CSV/TSV handling
  • All features work seamlessly across all supported file formats

Installation

Requires JupyterLab 4.0.0 or higher.

pip install jupyterlab_tabular_data_viewer_extension

Uninstall:

pip uninstall jupyterlab_tabular_data_viewer_extension

Configuration

Configure file type support through JupyterLab Settings:

  1. Open Settings → Settings Editor
  2. Search for "Parquet Viewer Extension"
  3. Configure options:
    • Enable Parquet files - Default: enabled
    • Enable Excel files - Default: disabled (enable to view .xlsx files)

When a file type is disabled, files open with JupyterLab's default handler instead.

Troubleshooting

Verify both extension components are enabled if the extension doesn't work:

# Check server extension
jupyter server extension list

# Check frontend extension
jupyter labextension list

Both commands should show jupyterlab_tabular_data_viewer_extension as enabled. Reinstall if either is missing or disabled.

Development Setup

Requires NodeJS for building TypeScript frontend. Uses jlpm (JupyterLab's pinned yarn version) for consistency.

Initial setup:

# Create virtual environment
python -m venv .venv
source .venv/bin/activate

# Install in editable mode
pip install --editable ".[dev,test]"

# Link frontend and enable server extension
jupyter labextension develop . --overwrite
jupyter server extension enable jupyterlab_tabular_data_viewer_extension

Development workflow:

Use two terminals for efficient development:

  • Terminal 1: jlpm watch (auto-rebuild on file changes)
  • Terminal 2: jupyter lab (run development instance)

Refresh browser after changes to see updates. Build generates source maps for debugging.

Enable deeper debugging with unminimized JupyterLab build:

jupyter lab build --minimize=False

Removing development installation:

jupyter server extension disable jupyterlab_tabular_data_viewer_extension
pip uninstall jupyterlab_tabular_data_viewer_extension

Then delete the jupyterlab_tabular_data_viewer_extension symlink from your labextensions directory (find with jupyter labextension list).

Testing

Three-tier testing strategy: Python backend, TypeScript frontend, and integration tests.

Python tests (pytest with coverage):

pip install -e ".[test]"
jupyter labextension develop . --overwrite
pytest -vv -r ap --cov jupyterlab_tabular_data_viewer_extension

TypeScript tests (Jest):

jlpm
jlpm test

Integration tests (Playwright + Galata): Simulates real user interactions to validate complete workflows. See ui-tests README for detailed instructions.

Packaging and Release

See RELEASE.md for instructions on building distributable packages and publishing releases.

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

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file jupyterlab_tabular_data_viewer_extension-1.1.20.tar.gz.

File metadata

File hashes

Hashes for jupyterlab_tabular_data_viewer_extension-1.1.20.tar.gz
Algorithm Hash digest
SHA256 edf28da1a64445a0006cc817c637f91dadcb036c2c403f3b93d11a84c29a1c2d
MD5 e421c45703f883b562a393b398e3279c
BLAKE2b-256 65fd5f77491dc7ff42b5d2fe7322689e0cca75a84564d494c7abbfd34fb761e4

See more details on using hashes here.

File details

Details for the file jupyterlab_tabular_data_viewer_extension-1.1.20-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_tabular_data_viewer_extension-1.1.20-py3-none-any.whl
Algorithm Hash digest
SHA256 fb3acf16af65273d882e1d415a2e59f5b76c6428dc841fac4f2e13f185ae975f
MD5 808cb33a077e41924c69a0e4a0fc2cf1
BLAKE2b-256 3a81307eacc84359a39b073f1be0b3f7474c37336fb5f7017307097585a98947

See more details on using hashes here.

Supported by

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