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 == 3.6

Install

To install the extension, execute:

conda install -c conda-forge jupyterlab-blockly

Kernels

Uninstall

To remove the extension, execute:

conda uninstall -c conda-forge 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 yarn pre-commit jupyterlab==3.6 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.0a0.tar.gz (4.2 MB view details)

Uploaded Source

Built Distribution

jupyterlab_blockly-0.3.0a0-py3-none-any.whl (1.2 MB view details)

Uploaded Python 3

File details

Details for the file jupyterlab_blockly-0.3.0a0.tar.gz.

File metadata

  • Download URL: jupyterlab_blockly-0.3.0a0.tar.gz
  • Upload date:
  • Size: 4.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.10

File hashes

Hashes for jupyterlab_blockly-0.3.0a0.tar.gz
Algorithm Hash digest
SHA256 871411fc596add24594f635fa72f18b361ef4f62d33ec5bb58f594cf020f202b
MD5 493f3eb3424b60abfe91cb382ec9be85
BLAKE2b-256 ba09261ea0b5adbe226b4ee443f8ca72dc2aafcdd9f59725a4c8b999d2c91a3e

See more details on using hashes here.

File details

Details for the file jupyterlab_blockly-0.3.0a0-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_blockly-0.3.0a0-py3-none-any.whl
Algorithm Hash digest
SHA256 ba9f774c685c5a68f2f427eaded10a1bb737a2ec27082f93ade180f60c0a3dd6
MD5 4d62f51a5c53a184724f147ead829d78
BLAKE2b-256 29a56cb50c5e4b33c59536ebdbcd8e9562f718e2021bbb21555d72e6cdbb79a0

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