jupysql-plugin

jupysql-plugin

[!TIP] Deploy AI apps for free on Ploomber Cloud!

[!NOTE] Code in the main branch is compatible with JupyterLab 4 (0.4.x or higher releases), the jupyterlab3 branch contains code compatible with JupyterLab 3 (0.3.x releases). We'll keep backporting some features and making 0.3.x releases for some time, but we highly recommend upgrading to JupyterLab 4 for a better experience.

Install

pip install jupysql-plugin

Contributing

Development install

conda create --name jupysql-plugin python=3.11 --channel conda-forge --yes
conda activate jupysql-plugin
conda install nodejs=20 --channel conda-forge --yes
pip install -r requirements.txt
pip install -r requirements.dev.txt

jlpm install

Note: pkgmt format can be used to format and lint Python files before committing code. To format JavaScript and TypeScript files, use yarn run eslint. To lint without formatting, use yarn run eslint:check

# Note: this command will take some time the first time as it has to compile the
# frontend code. If the command fails, see the "troubleshooting setup" section below
pip install -e "."

# upon installation, both the frontend and backend extensions must be activated
# automatically, you can verify it by ensuring jupysql-plugin appears here:
jupyter labextension list # frontend extension
jupyter server extension list # backend extension

# if they don't appear, you can activate them manually, but this means that
# the setup is incorrect! see pyproject.toml, under
# tool.hatch.build.targets.wheel.shared-data, and fix any issues

# activate manually
jupyter server extension enable jupysql_plugin
jupyter labextension enable jupysql_plugin


jupyter labextension develop . --overwrite

# NOTE: the two previous commands will fail if there are missing dependencies

# rebuild extension Typescript
# important: we had to set skipLibCheck: true
# https://discourse.jupyter.org/t/struggling-with-extensions-and-dependencies-versions/19550
jlpm build

To watch for changes and reload:

# in one terminal
jlpm watch

# another terminal
jupyter lab

Refresh JupyterLab to load the change in your browser.

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

Troubleshooting setup

If you encounter errors when installing the package for development, you can try the following to configure an environment from scratch:

# remove conda environment
conda env remove --name jupysql-plugin

# delete yarn.lock
rm yarn.lock

# delete all temporary files
git clean -fdx

Then, create the conda environment again, install dependencies (jlpm install), and build the extension manually (jupyter labextension build --development True .). Finally, verify if pip install -e "." works.

Adding dependencies

jlpm add PACKAGE

# example
jlpm add @jupyter-widgets/base

Development uninstall

pip uninstall jupysql-plugin

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 jupysql-plugin within that folder.

Testing the extension

This extension is using Jest for JavaScript code testing.

This extension uses Playwright for the integration tests (aka user level tests). More precisely, the JupyterLab helper Galata is used to handle testing the extension in JupyterLab. More information are provided within the ui-tests README.

To run the tests:

pip install nox pyyaml

# unit tests
nox --session test

# ui tests
nox --session ui_test

# to only run the python unit tests
pytest tests

Releasing the extension

See RELEASE

Configuration

The package.json file contains a jupyterlab extension. More information about this section is here (you might need to switch the git branch dependin on which version JupyterLab version you're building for). The schema is here.

Ploomber Cloud API Endpoint

You can set the PLOOMBER_CLOUD_HOST variable to switch the API endpoint (by default, it's set to our production API endpoint).

export PLOOMBER_CLOUD_HOST=https://cloudapi-dev.ploomber.io