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.4

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 pre-commit yarn jupyterlab==3.4 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 .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm run 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 run 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 run 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.1.1.tar.gz (3.1 MB view details)

Uploaded Source

Built Distribution

jupyterlab_blockly-0.1.1-py3-none-any.whl (2.1 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: jupyterlab_blockly-0.1.1.tar.gz
  • Upload date:
  • Size: 3.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for jupyterlab_blockly-0.1.1.tar.gz
Algorithm Hash digest
SHA256 e72460a8ec60344fbe3d7e7621259a5ea0a7a0aebf2cd50a4c929770f1ae0013
MD5 229bdffd07b8d0505b56e383718014e3
BLAKE2b-256 50181ce0adbd95dad19810e2bd06c2661c0668a3b688c5d76446f5dd4d2924c2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for jupyterlab_blockly-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 babc059c05ba8f5219fbcee7d2aa254e6bbbbe6aa53b4e1cd5380f8e88f0d209
MD5 4cf72f33f81d11ef57bb36c6ce1d4a45
BLAKE2b-256 ca7e590e83c2d47fa1023060313a03e47525c27e7d7f0676a422dde95b421075

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