Skip to content

Commit

Permalink
Update Readme and docs with latest supported Qt versions (#580)
Browse files Browse the repository at this point in the history
Co-authored-by: Carlos Cordoba <[email protected]>
  • Loading branch information
stonebig and ccordoba12 authored May 14, 2023
1 parent 28b8f0e commit d700870
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 19 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,7 @@ and more.
![qtconsole](https://raw.githubusercontent.com/jupyter/qtconsole/master/docs/source/_images/qtconsole.png)

## Install Qtconsole
The Qtconsole requires Python bindings for Qt, such as [PyQt5](http://www.riverbankcomputing.com/software/pyqt/intro),
[PyQt4](https://www.riverbankcomputing.com/software/pyqt/download),
or [PySide](http://pyside.github.io/docs/pyside).
The Qtconsole requires Python bindings for Qt, such as [PyQt6](https://pypi.org/project/PyQt6/), [PySide6](https://pypi.org/project/PySide6/), [PyQt5](https://pypi.org/project/PyQt5/) or [PySide2](https://pypi.org/project/PySide2/).

Although [pip](https://pypi.python.org/pypi/pip) and
[conda](http://conda.pydata.org/docs) may be used to install the Qtconsole, conda
Expand Down
25 changes: 9 additions & 16 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
Installation
============
The Qt console requires Qt, such as
`PyQt5 <https://www.riverbankcomputing.com/software/pyqt/intro>`_,
`PyQt4 <https://www.riverbankcomputing.com/software/pyqt/download>`_, or
`PySide <http://pyside.github.io/docs/pyside>`_.
`PyQt6 <https://pypi.org/project/PyQt6>`_,
`PySide6 <https://pypi.org/project/PySide6>`_,
`PyQt5 <https://pypi.org/project/PyQt5>`_,
`PySide2 <https://pypi.org/project/PySide2>`_.

Although `pip <https://pypi.python.org/pypi/pip>`_ and
`conda <http://conda.pydata.org/docs>`_ may be used to install the Qt console,
conda is simpler to use since it automatically installs PyQt. Alternatively,
qtconsole installation with pip needs additional steps since pip cannot install
the Qt requirement.
conda is simpler to use since it automatically installs PyQt.

Install using conda
-------------------
Expand All @@ -28,27 +27,21 @@ To install::

pip install qtconsole

.. important::

Make sure that Qt is installed. Unfortunately, Qt cannot be
installed using pip. The next section gives instructions on installing Qt.

Installing Qt (if needed)
-------------------------
We recommend installing PyQt with `conda <http://conda.pydata.org/docs>`_::

conda install pyqt

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

pip install PyQt5

For example with Linux Debian's system package manager, use::

sudo apt-get install python3-pyqt5 # PyQt5 on Python 3
sudo apt-get install python3-pyqt4 # PyQt4 on Python 3
sudo apt-get install python-qt4 # PyQt4 on Python 2

.. seealso::
See also::

`Installing Jupyter <https://jupyter.readthedocs.io/en/latest/install.html>`_
The Qt console is part of the Jupyter ecosystem.

0 comments on commit d700870

Please sign in to comment.