Skip to main content

jupyterlab_basic_terminal_extension

GitHub Actions npm version PyPI version Total PyPI downloads JupyterLab 4 Brought To You By KOLOMOLO Donate PayPal

Launch a utility terminal in JupyterLab that runs without a shell. Perfect for spawning short-lived console utilities that close their tab automatically when the underlying process exits, instead of leaving behind an idle shell prompt.

Features

  • Shell-less terminal command - Adds a JupyterLab command that opens a terminal bound directly to a utility process, with no surrounding shell
  • Auto-close on exit - Terminal tab closes as soon as the utility process finishes, keeping the workspace tidy
  • Server extension companion - Python jupyter_server extension exposes the route used by the frontend to spawn the process
  • JupyterLab 4 native - Built against @jupyterlab/application 4.x and ships as a prebuilt federated extension

Installation

Requires JupyterLab 4.6 or higher, and bash on the server - the terminal initialisation step uses bash-specific syntax, so a sh-only image will not work.

pip install jupyterlab_basic_terminal_extension

Usage

The extension deliberately adds no menu item, palette entry or launcher tile. Its entire surface is one command, invoked programmatically by other extensions, notebook code, or a jupyter_app_launcher tile:

await app.commands.execute('basic-terminal:launch', {
  argv: ['/opt/utils/my-utility.sh'],
  cwd: 'projects/demo'
});
  • argv (required) - non-empty array of strings. argv[0] is executed directly; there is no shell, so no globbing, pipes or redirection
  • cwd (optional) - absolute path used as-is, or a server-relative path resolved against ServerApp.root_dir ('' is the root). Omit it and the current file browser folder is used, unless the browser is on a registered non-default drive - such a drive is not assumed to map onto the server filesystem, so the server's own working directory is used instead. A path that does not resolve to a directory is rejected with HTTP 400
  • shutdownOnClose (optional, default false) - when true, closing the tab this command opened while the program still runs shuts the terminal session down, which ends the program; a tab the lab restores after a page reload does not carry the argument. When false or omitted, the lab's terminal setting Shut down on close decides, as in 1.0.8; its default false leaves the program running on the server after the tab is closed

The command resolves to the terminal widget, and rejects if the process exits before the widget can be displayed.

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab_basic_terminal_extension

Metadata

Release files for jupyterlab-basic-terminal-extension 1.0.11

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for jupyterlab-basic-terminal-extension 1.0.11
File Size Uploaded Provenance Actions
jupyterlab_basic_terminal_extension-1.0.11.tar.gz 283.6 kB Without provenance Details for jupyterlab_basic_terminal_extension-1.0.11.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for jupyterlab-basic-terminal-extension 1.0.11
File Interpreter ABI Platform Actions
jupyterlab_basic_terminal_extension-1.0.11-py3-none-any.whl Python 3 none any Details for jupyterlab_basic_terminal_extension-1.0.11-py3-none-any.whl

Total release size: 319.0 kB

Release files / jupyterlab_basic_terminal_extension-1.0.11.tar.gz

Download URL jupyterlab_basic_terminal_extension-1.0.11.tar.gz
Size 283.6 kB
Tags Source
SHA-256 checksum
How to use checksums
17146bee4cea03c0c4a88eecd2e3e29f8e444a220226cb6280b30137c6f3daeb
BLAKE2b-256 checksum
How to use checksums
ee7b65eab99495e06d907a38f367255ac4f2b13f7042cfc3267506e0e0bd7b3a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.10

Release files / jupyterlab_basic_terminal_extension-1.0.11-py3-none-any.whl

Download URL jupyterlab_basic_terminal_extension-1.0.11-py3-none-any.whl
Size 35.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
81930f80097d8ef590144a03c4bb45f41f1e06969e2861c2304d33718a655bf3
BLAKE2b-256 checksum
How to use checksums
26b0210f8e840630b6861a4ff99e788750d0bfa90a71d029d9b820bd6384929f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.10

Security for jupyterlab-basic-terminal-extension 1.0.11

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page