Skip to main content

Control JupyterLab from Python Notebooks

Project description

ipylab

Github Actions Status Binder Conda Version pypi npm

Control JupyterLab from Python notebooks.

The goal is to provide access to most of the JupyterLab environment from Python notebooks. For example:

  • Adding widgets to the main area DockPanel, left, right or top area
  • Build more advanced interfaces leveraging SplitPanel, Toolbar and other Lumino widgets
  • Launch arbitrary commands (new terminal, change theme, open file and so on)
  • Open a workspace with a specific layout
  • Listen to JupyterLab signals (notebook opened, console closed) and trigger Python callbacks

Try it online

Try it in your browser with Binder:

Binder

Examples

Add Jupyter Widgets to the JupyterLab interface

widgets-panels

Execute Commands

command-registry

Custom Python Commands and Command Palette

custom-commands

Build small applications

ipytree-example

Compatibility with RetroLab

A subset of the features can be used in RetroLab:

retrolab-example

Installation

You can install using pip:

pip install ipylab

Or with mamba / conda:

mamba install -c conda-forge ipylab

Running the examples locally

To try out the examples locally, the recommended way is to create a new environment with the dependencies:

# create a new conda environment
conda create -n ipylab-examples -c conda-forge jupyterlab ipylab ipytree bqplot ipywidgets numpy
conda activate ipylab-examples

# start JupyterLab
jupyter lab

Under the hood

ipylab can be seen as a proxy from Python to JupyterLab over Jupyter Widgets:

ipylab-diagram

Development

# create a new conda environment
mamba create -n ipylab -c conda-forge jupyter-packaging nodejs python -y

# activate the environment
conda activate ipylab

# install the Python package
python -m pip install -e ".[dev]"

# link the extension files
jupyter labextension develop . --overwrite

# compile the extension
jlpm && jlpm run build

Related projects

There are a couple of projects that also enable interacting with the JupyterLab environment from Python notebooks:

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

ipylab-0.6.0.tar.gz (388.0 kB view details)

Uploaded Source

Built Distribution

ipylab-0.6.0-py3-none-any.whl (767.1 kB view details)

Uploaded Python 3

File details

Details for the file ipylab-0.6.0.tar.gz.

File metadata

  • Download URL: ipylab-0.6.0.tar.gz
  • Upload date:
  • Size: 388.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for ipylab-0.6.0.tar.gz
Algorithm Hash digest
SHA256 4c8f0d7c13834e7f8629de1c86f54113f76e1f373b930a99df09087300338c5d
MD5 e47234f15e144c31e2d9d533565299eb
BLAKE2b-256 67871426fa011068cb6610010af2ad2bca942711cd46a9b7c4185ea99fe4280c

See more details on using hashes here.

File details

Details for the file ipylab-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: ipylab-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 767.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for ipylab-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ecdda4eb6474bbc03f241b39a4f9fa9d964f64498c0f5db1eb3144f29c24fd84
MD5 fd8f58d7759685643e1e27a238cb1ce3
BLAKE2b-256 bfc5aa20f3f0f60b283d30ea0b202bce70c1cff15ec46c13b3bdde0de465e783

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