Skip to main content

A JupyterLab extension for the BQN language.

Project description

jupyterlab_bqn

Github Actions Status A JupyterLab extension for the BQN language.

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install jupyterlab_bqn

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab_bqn

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_bqn directory
# Install package in development mode
pip install -e "."
# 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_bqn

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

Packaging the extension

See RELEASE

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_bqn-0.1.1.tar.gz (115.1 kB view details)

Uploaded Source

Built Distribution

jupyterlab_bqn-0.1.1-py3-none-any.whl (40.1 kB view details)

Uploaded Python 3

File details

Details for the file jupyterlab_bqn-0.1.1.tar.gz.

File metadata

  • Download URL: jupyterlab_bqn-0.1.1.tar.gz
  • Upload date:
  • Size: 115.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for jupyterlab_bqn-0.1.1.tar.gz
Algorithm Hash digest
SHA256 b1b6ecbe22cf7e4acebe666f49a881bec9ab9ae2708c89fc43195d72f8acb094
MD5 4663513f792ef46b96ef7e377248903d
BLAKE2b-256 98593f6b3620712c8e923af5250c5d3bd571b1d4ecedccf3760f679beae07a6d

See more details on using hashes here.

File details

Details for the file jupyterlab_bqn-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_bqn-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c3d3613b476ed700dac84a98540dfde28078650b767a7b28fc5b5513d960a79f
MD5 c6aaf6ba804b956145217d8e81771179
BLAKE2b-256 06fb408ec7a45e50a912fcad3ce85e028553a6e4e5da3bbc11823bba43c81eda

See more details on using hashes here.

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