---
id: ipylab
version: "1.1.0"
license: Copyright (c) 2020 ipylab contributors All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are… (full text in the JSON record)
license_treatment: permissive
maintenance: aging
---

# ipylab — Control JupyterLab from Python notebooks

License: permissive · Maintenance: aging · Downloads: 241.3K/mo

## What it is and what it does

ipylab is a Python library that bridges JupyterLab's interface with notebook code, letting you programmatically manipulate the lab environment. It acts as a proxy from Python to JupyterLab over Jupyter Widgets, exposing the lab's UI components and command system to notebook code.

You can use it to add custom widgets to the main area or sidebar, launch commands (like opening terminals or changing themes), listen to lab events (notebook opened, console closed) and trigger Python callbacks, and build small applications with advanced layouts using Lumino widgets. It depends only on ipywidgets and is compatible with Python 3.8 through 3.12.

Use it for:

- Add interactive widgets to JupyterLab's main panel or sidebars directly from notebook code.
- Programmatically execute JupyterLab commands like opening files, launching terminals, or switching themes.
- Build custom dashboards or control panels inside notebooks that respond to lab events.
- Create reproducible lab layouts and workspaces configured entirely in Python.
- Listen to JupyterLab signals (notebook opened, closed) and trigger Python-side actions in response.

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

ipylab lets you control JupyterLab's interface and behavior from Python code running in notebooks—adding widgets to panels, executing commands, listening to events, and building custom layouts.

Yes, if you work regularly in JupyterLab and want to automate or customize its interface from Python. The low install friction and permissive license make it a low-risk addition. The aging maintenance (last release 416 days ago) is a minor concern but not a blocker—the project is not archived and remains compatible with current JupyterLab versions. Not necessary if you only use JupyterLab's standard interface.

## Install

pip install ipylab
uv add ipylab
poetry add ipylab

## Installing ipylab

Before you install: Low friction install with a single runtime dependency (ipywidgets). The project shows aging maintenance—last release was 416 days ago—but the repository remains active and not archived, suggesting it is stable rather than abandoned.

License in practice: BSD 3-Clause permissive license. You can use, modify, and distribute ipylab freely in commercial and private projects as long as you retain the copyright notice and disclaimer.

Quickstart:

pip install ipylab

import ipylab
from ipywidgets import Button

button = Button(description='Click me')
ipylab.dock_panel.add_widget(button, 'My Widget')

Requires JupyterLab 4 running in a browser; cannot be used in standard IPython or non-Jupyter environments.

Verify before relying:

- Whether the aging maintenance status (416 days since last release) affects compatibility with the latest JupyterLab versions.
- Whether all listed features (DockPanel, SplitPanel, Toolbar, signal listening) are equally mature or if some are experimental.

## Package facts

- License: Copyright (c) 2020 ipylab contributors All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are… (full text in the JSON record) (permissive)
- Python support: supports_current
- Install friction: low
- Maintenance: aging
- Downloads: 241.3K/month (top 15,000 on PyPI)
- Known vulnerabilities: none known

## Tags

jupyterlab control from python, jupyter notebook ui automation, jupyterlab widget integration, programmatic jupyterlab interface, jupyter command execution python, jupyterlab layout management, notebook-driven lab interface, jupyterlab-extension, notebook-automation, ui-control

[View on SkillFed](https://skillfed.io/packages/ipylab) · [View on PyPI](https://pypi.org/project/ipylab/)