README.md

QtPy: Abstraction layer for PyQt5/PyQt4/PySide2/PySide

Copyright © 2009–2019 The Spyder Development Team

Description

QtPy is a small abstraction layer that lets you write applications using a single API call to either PyQt or PySide.

It provides support for PyQt5, PyQt4, PySide2 and PySide using the Qt5 layout (where the QtGui module has been split into QtGui and QtWidgets).

Basically, you can write your code as if you were using PySide2 but import Qt modules from qtpy instead of PySide2 (or PyQt5)

Attribution and acknowledgments

This project is based on the pyqode.qt project and the spyderlib.qt module from the Spyder project, and also includes contributions adapted from qt-helpers, developed as part of the glue project.

Unlike pyqode.qt this is not a namespace package, so it is not tied to a particular project or namespace.

License

This project is released under the MIT license.

Requirements

You need PyQt5, PyQt4, PySide2 or PySide installed in your system to make use of QtPy. If several of these packages are found, PyQt5 is used by default unless you set the QT_API environment variable.

QT_API can take the following values:

• pyqt5 (to use PyQt5).
• pyqt or pyqt4 (to use PyQt4).
• pyside2 (to use PySide2)
• pyside (to use PySide).

Installation

pip install qtpy

or

conda install qtpy

Contributing

Everyone is welcome to contribute!

Sponsors

Become a sponsor to get your logo on our README on Github.