Jupyter Server Terminals

0.5.4 · active · verified Sun Mar 29

Jupyter Server Terminals is a Jupyter Server Extension that provides robust terminal support within the Jupyter environment. It allows users to run system shells directly in their web browser, offering functionalities akin to a local terminal. The library is actively maintained, with regular releases focusing on bug fixes and maintenance, and is currently at version 0.5.4. It requires Python >=3.8.

Warnings

breaking Jupyter Server Terminals versions 0.5.0 and newer explicitly require Jupyter Server 2.0+ to function correctly. Older versions of Jupyter Server will result in an error during extension loading.
Fix: Upgrade your `jupyter-server` installation to version 2.0 or higher: `pip install --upgrade jupyter-server`.
gotcha The 'Terminals Service' transitioned from a core Jupyter Service to a Jupyter Server extension in Jupyter Server 2.0. While most end-users won't notice, this impacts how the service is managed and can be optionally disabled, which is relevant for sensitive deployment environments or advanced configurations.
Fix: Be aware of this architectural change if you're developing extensions that interact directly with Jupyter Server services or managing custom deployments. The service can now be managed as a standard Jupyter extension.
gotcha Jupyter environments (including terminals) can suffer from memory issues, leading to unresponsive sessions or saving errors. This is often due to poor 'server hygiene,' such as not closing notebooks/terminals, excessive output, or inefficient code.
Fix: Always close and halt notebooks (`File > Close and Halt`) and exit terminals (`exit` command) when not in use. Minimize the number of open tabs and avoid printing excessively large outputs. Re-use variables instead of creating multiple copies of large data in memory.
gotcha On *nix shells in JupyterLab, the default keyboard shortcut for copying (Ctrl+Shift+C) can conflict with the default shortcut for toggling the command palette (`apputils:activate-command-palette`).
Fix: If experiencing conflicts, consider changing the keyboard shortcut for either copy or the command palette in JupyterLab's settings. Alternatively, use Ctrl+Shift+V for paste, which works as usual, or hold Shift and right-click for the native browser context menu (though this may not work in all browsers).

Install

pip install jupyter_server_terminals Install latest version

Imports

Extension configuration
```
This library is primarily a Jupyter Server extension. Direct Python imports for programmatic end-user terminal creation or management are not its primary interface. Its functionality is exposed via the Jupyter Server and its web UI (JupyterLab/Notebook).
```
Users typically interact with terminals via the Jupyter web interface after installing the extension. For advanced server-side configuration, one would interact with the Jupyter Server's extension management system, not direct imports from jupyter_server_terminals.

Quickstart

Install the `jupyter_server_terminals` extension along with `jupyterlab` (or `notebook`). Once installed, start JupyterLab from your terminal. The terminal functionality will be automatically available within the JupyterLab interface. You can open a new terminal from the Launcher or through the File menu.

pip install jupyter_server_terminals jupyterlab
jupyter lab

view raw JSON →