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.2.0.tar.gz (3.1 MB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: jupyterlab_blockly-0.2.0.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.2.0.tar.gz
Algorithm Hash digest
SHA256 cab7bd513f204b2689978822a58a0dfcb232391822e53fe1007e999eda77c974
MD5 26ceb7ebe4e4bef3db95f66635e6ef6a
BLAKE2b-256 9566646a03880ad35b7bce44fe26839608dc499a9813d6cddfbeeb8647fdeed1

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for jupyterlab_blockly-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e6133d5c66dd72e863c148937cf583f7d20e4cba7202b5b31d2461d61df0103b
MD5 d23b22adc3a31b89433725fe338aebd4
BLAKE2b-256 911d4d14e09ca680bc32dff182842cb483e202d55a5c2adb22c719b7a63fed1d

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