Home

Awesome

Jupyter QtConsole

Windows tests Macos tests Linux tests Coverage Status Documentation Status Google Group

A rich Qt-based console for working with Jupyter kernels, supporting rich media output, session export, and more.

The Qtconsole is a very lightweight application that largely feels like a terminal, but provides a number of enhancements only possible in a GUI, such as inline figures, proper multiline editing with syntax highlighting, graphical calltips, and more.

qtconsole

Install Qtconsole

The Qtconsole requires Python bindings for Qt, such as PyQt6, PySide6, PyQt5 or PySide2.

Although pip and conda may be used to install the Qtconsole, conda is simpler to use since it automatically installs PyQt5. Alternatively, the Qtconsole installation with pip needs additional steps since pip doesn't install the Qt requirement.

Install using conda

To install:

conda install qtconsole

Note: If the Qtconsole is installed using conda, it will automatically install the Qt requirement as well.

Install using pip

To install:

pip install qtconsole

Note: Make sure that Qt is installed. Unfortunately, Qt is not installed when using pip. The next section gives instructions on doing it.

Installing Qt (if needed)

You can install PyQt5 with pip using the following command:

pip install pyqt5

or with a system package manager on Linux. For Windows, PyQt binary packages may be used.

Note: Additional information about using a system package manager may be found in the qtconsole documentation.

More installation instructions for PyQt can be found in the PyQt5 documentation and PyQt4 documentation

Source packages for Windows/Linux/MacOS can be found here: PyQt5 and PyQt4.

Usage

To run the Qtconsole:

jupyter qtconsole

Resources