Skip to main content

A JupyterLab extension for jpfiddle.

Project description

jpfiddle_extension

Github Actions Status

A JupyterLab extension for jpfiddle.

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install jpfiddle_extension

Uninstall

To remove the extension, execute:

pip uninstall jpfiddle_extension

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 jpfiddle_extension 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 jpfiddle_extension

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 jpfiddle_extension 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

jpfiddle_extension-0.1.12.tar.gz (85.9 kB view details)

Uploaded Source

Built Distribution

jpfiddle_extension-0.1.12-py3-none-any.whl (15.5 kB view details)

Uploaded Python 3

File details

Details for the file jpfiddle_extension-0.1.12.tar.gz.

File metadata

  • Download URL: jpfiddle_extension-0.1.12.tar.gz
  • Upload date:
  • Size: 85.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.9.0

File hashes

Hashes for jpfiddle_extension-0.1.12.tar.gz
Algorithm Hash digest
SHA256 e2aeede8aee98a32506201306e1684d98103604d10303ca14b4cc8d7fc57a1f4
MD5 969a6a99235847071fe274c6eb2c479c
BLAKE2b-256 1731ff1161b5748848a1280ebf0213e3a34ff213a9d80863c153b16db9254a9c

See more details on using hashes here.

Provenance

File details

Details for the file jpfiddle_extension-0.1.12-py3-none-any.whl.

File metadata

File hashes

Hashes for jpfiddle_extension-0.1.12-py3-none-any.whl
Algorithm Hash digest
SHA256 84720f45e8f11629703b43fde0dc89d002e13da3f4617b461d5345eba45f99ba
MD5 ba62a5f9612c1fee2af60e95b0d07e8e
BLAKE2b-256 e957d168bd36d884edbbd0b3fe56ea7c63cf75aac4d76d2b23835c71922cd030

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