Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PR: Update Readme to mention that we now support PySide2. #114

Merged
merged 2 commits into from
May 9, 2017
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# QtPy: Abtraction layer for PyQt5/PyQt4/PySide
# QtPy: Abtraction layer for PyQt5/PyQt4/PySide2/PySide

Copyright © 2009- The Spyder Development Team.

Expand All @@ -19,8 +19,8 @@ Copyright © 2009- The Spyder Development Team.
**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 and PySide using the PyQt5 layout (where
the QtGui module has been split into QtGui and QtWidgets).
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 write your code as if you were using PyQt5 but import Qt modules
Copy link
Member

@goanpeca goanpeca May 9, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ccordoba12 @rlaverde we should change this to

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

Which is what we actually do, because we use Signal instead of (PyQt5Signal) for instance....

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rlaverde, please open a new PR for this.

from `qtpy` instead of `PyQt5`.
Expand All @@ -46,14 +46,15 @@ This project is licensed under the MIT license.

### Requirements

You need PyQt5, PyQt4 or PySide installed in your system to make use
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).


Expand Down