Skip to main content

Blockly extension for JupyterLab.

Project description

jupyterlab-blockly

Github Actions Status lite-badge Binder

Blockly extension for JupyterLab.

Blockly

Blockly is a library from Google for building beginner-friendly block-based programming languages.

Docs: https://developers.google.com/blockly/guides/overview Repo: https://github.com/google/blockly

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

conda install -c conda-forge jupyterlab-blockly

or

pip install jupyterlab-blockly

Kernels

Uninstall

To remove the extension, execute:

conda uninstall -c conda-forge jupyterlab-blockly

or

pip install jupyterlab-blockly

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.

micromamba create -n blockly -c conda-forge python nodejs=18 pre-commit jupyterlab jupyter-packaging jupyterlab-language-pack-es-ES jupyterlab-language-pack-fr-FR ipykernel xeus-python xeus-lua
micromamba activate blockly
# Clone the repo to your local environment
# Change directory to the jupyterlab_blockly directory
# Installing pre-commit to run command when adding commits
pre-commit install
# Install package in development mode
pip install -e ".[dev]"
# 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_blockly

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-blockly 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_blockly-0.3.3.tar.gz (4.6 MB view details)

Uploaded Source

Built Distribution

jupyterlab_blockly-0.3.3-py3-none-any.whl (1.9 MB view details)

Uploaded Python 3

File details

Details for the file jupyterlab_blockly-0.3.3.tar.gz.

File metadata

  • Download URL: jupyterlab_blockly-0.3.3.tar.gz
  • Upload date:
  • Size: 4.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for jupyterlab_blockly-0.3.3.tar.gz
Algorithm Hash digest
SHA256 0737bfbba9f2c7dbde28475e9d269419254a49974873d0de2fdc94134c69f7f2
MD5 25856447d7b9b7b4011054d9105250e7
BLAKE2b-256 fe3dd1ff6b4362636c59508c460ccfee8393be49323e7a549216120fa297ab89

See more details on using hashes here.

Provenance

File details

Details for the file jupyterlab_blockly-0.3.3-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_blockly-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 91cdeb77949ba4694d92c5b28ec2b62ecb3852983f62e7a1833bb1a204eff4b3
MD5 239130498958267112ce22ea96245953
BLAKE2b-256 9bb560a8bc224d3184da954a693625fcd0d44cdb82fb4b306337f6f65353b8a3

See more details on using hashes here.

Provenance

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