Skip to main content

jupyterlab_sql_editor

Github Actions Status SQL editor support for formatting, syntax highlighting and code completion of SQL in cell magic, line magic, python string and file editor.

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install jupyterlab_sql_editor[all]

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab_sql_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_sql_editor directory
# Install package in development mode
pip install -e .[all]
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm 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 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 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

Development uninstall

pip uninstall jupyterlab_sql_editor

In development mode, you will also need to remove the symlink created by jupyter labextension develop command. To find its location, you can run jupyter labextension list to figure out where the labextensions folder is located. Then you can remove the symlink named jupyterlab-sql-editor within that folder.

Packaging the extension

See RELEASE

Download files

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

Source Distribution

jupyterlab_sql_editor-1.10.0.tar.gz (23.4 MB view details)

Uploaded Source

Built Distribution

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

jupyterlab_sql_editor-1.10.0-py3-none-any.whl (151.7 kB view details)

Uploaded Python 3

File details

Details for the file jupyterlab_sql_editor-1.10.0.tar.gz.

File metadata

  • Download URL: jupyterlab_sql_editor-1.10.0.tar.gz
  • Upload date:
  • Size: 23.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.18

File hashes

Hashes for jupyterlab_sql_editor-1.10.0.tar.gz
Algorithm Hash digest
SHA256 58a8fc8eef8d6bfd5f44c86cddf737792346b8abd3b55a60ab52ce6f521f6778
MD5 dcba29a74a4ef1e7bb2a7f3dc7527dc0
BLAKE2b-256 45bc5f8d52a0025f06c1a87c8a0af3fe2a56ee1e3fc737bfd055910c7b5ee688

See more details on using hashes here.

File details

Details for the file jupyterlab_sql_editor-1.10.0-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_sql_editor-1.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 22920cfe00543ef5d62b431ddb01d3d9503ea5d79b9be7702a444859feb64135
MD5 49fb77ac9760771a7d77f53ba9829b94
BLAKE2b-256 0a09bc507625d1b28ae259eb21077f96d8557912d2d6b1af8f395180cc7fc05c

See more details on using hashes here.

Release history Release notifications | RSS feed

Supported by

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