JSONiq JupyterLab Extension

jsoniq-jupyterlab-extension is a JupyterLab extension that adds basic token highlighting for JSONiq code. Syntax highlighting with CodeMirror is enabled for jsoniq cells using the %%jsoniq magic and for .jq files.

Features

  • Basic token highlighting - provides JSONiq token highlighting for %%jsoniq magic cells within Python notebooks.
  • Syntax highlighting for .jq files - can be enabled for .jq files using the Jupyter language selector.

Installation

Install the extension from Python packaging. No npm or yarn installation is required for users.

To install, run:

pip install jsoniq-jupyterlab-extension

After installing the package, you may need to enable the extension in JupyterLab:

jupyter labextension enable jsoniq-jupyterlab-extension

Usage

Once the extension is installed and enabled, it automatically recognizes jsoniq magic cells and files for syntax highlighting.

Example

%%jsoniq
for $book in json-file("books.json")
where $book.price lt 20
return $book.title

This cell should become highlighted.

Development

To contribute to the development of jsoniq-jupyterlab, follow these steps:

  1. Clone the repository:

    git clone https://github.com/davidbuzatu-marian/jsoniq-jupyterlab.git
cd jsoniq-jupyterlab

  2. Install dependencies:

    pnpm install         # Install JavaScript dependencies
pnpm run antlr4      # Generate parser from grammar
uv python install    # Setup Python environment using uv
uv sync              # Sync dependencies for Python environment

  3. Build the extension:

    uv run pnpm run build:prod

  4. Link the extension for local development:

    jupyter labextension link .

  5. Launch JupyterLab:

    jupyter lab

Building and testing the extension

To build the project for production, the following commands build the JavaScript files, build the Jupyter extension and install this result for local testing.

uv run pnpm run build:prod

Project Structure

  • src/: Contains the source code of the extension.
  • dist/: Build artifacts for the extension.
  • package.json: Contains the configuration and dependencies for the extension.
  • tests/: Contains a set of tests relating to syntax highlighting.

Contributing

We welcome contributions to the jsoniq-jupyterlab-extension project! If you have any suggestions, bug reports, or pull requests, please feel free to submit them on the GitHub repository.

License

This project is licensed under the Apache-2.0 License. See the LICENSE file for details.

Project links

Data verified by PyPI on Aug 6, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

3 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for dbuzatu from gravatar.com dbuzatu Avatar for ghislain.fourny from gravatar.com ghislain.fourny Avatar for jimmycai from gravatar.com jimmycai

Credits

Author: JSONiq Development Team

GitHub Statistics

Data verified by PyPI on Aug 6, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

Apache-2.0
View SPDX License List

Requires

Python >=3.11

Tags

jsoniq

Report project as malware

Download files

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

Source Distribution

jsoniq_jupyterlab_extension-2.0.0.tar.gz (487.2 kB view details)

Uploaded Source

Built Distribution

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

jsoniq_jupyterlab_extension-2.0.0-py3-none-any.whl (234.6 kB view details)

Uploaded Python 3

File details

Details for the file jsoniq_jupyterlab_extension-2.0.0.tar.gz.

File metadata

File hashes

Hashes for jsoniq_jupyterlab_extension-2.0.0.tar.gz
Algorithm Hash digest
SHA256 e75c537b18c24c3be69f159e19c243d7f90324db9e37e0c60c8decc592e519c5
MD5 7514e2e50d2a52f9f26c76454a70db3f
BLAKE2b-256 e367bd1291460393b2b6df264bca1e06c2136321cf8de7627bd99537aca86a10

See more details on using hashes here.

Provenance

The following attestation bundles were made for jsoniq_jupyterlab_extension-2.0.0.tar.gz:

Publisher: publish.yml on RumbleDB/jsoniq-jupyterlab-extension

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file jsoniq_jupyterlab_extension-2.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for jsoniq_jupyterlab_extension-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 67cc0a5e2f3f01164612c57813831d62b28b205615367e1443834d27dbab23f5
MD5 66728de73d15c67e73058fc246252974
BLAKE2b-256 a110716592db402c55bf3b3546e2d8378c1556ca8022fbc494bde8b4033833b6

See more details on using hashes here.

Provenance

The following attestation bundles were made for jsoniq_jupyterlab_extension-2.0.0-py3-none-any.whl:

Publisher: publish.yml on RumbleDB/jsoniq-jupyterlab-extension

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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