Skip to main content

A jupyter lab/notebook front-end extension for running/executing cells on kernel start-up

Project description

iinit

Github Actions StatusBinder A jupyter lab/notebook front-end extension for running/executing cells on kernel start-up

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install iinit

Uninstall

To remove the extension, execute:

pip uninstall iinit

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

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

iinit-2.1.0.tar.gz (89.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

iinit-2.1.0-py3-none-any.whl (14.6 kB view details)

Uploaded Python 3

File details

Details for the file iinit-2.1.0.tar.gz.

File metadata

  • Download URL: iinit-2.1.0.tar.gz
  • Upload date:
  • Size: 89.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for iinit-2.1.0.tar.gz
Algorithm Hash digest
SHA256 de63ae0e81e43c159a41b856ddb93d7da2f886d69f89412b9fc00687f618ff14
MD5 47c80f5dd8f77e135afec2278f97329a
BLAKE2b-256 59b03055eb45c93b39a0dbb065fa703a11d96c526fee303222eb86378a1ff74d

See more details on using hashes here.

File details

Details for the file iinit-2.1.0-py3-none-any.whl.

File metadata

  • Download URL: iinit-2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 14.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for iinit-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 58b84ff73f2ebea65b0922e3c22d200830a3ab5a8f0b39b774f6db0aec67c027
MD5 0946895ec833e5c285d027fe9bebbdd5
BLAKE2b-256 d31bd78203809ed08cd75d9f59ac8a5ac49f031d17276d3bb51982a5db8a03fd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page