If you start building Python application with Qt5 you'll soon discover that there are in fact two packages which you can use to do this — PyQt and PySide. PyQt was developed by Phil Thompson of Riverbank Computing Ltd. supporting versions of Qt going back to 2.x under a GPL license. Back in 2009 the developers of Qt wanted to have Python bindings for Qt available under the LGPL license (like Qt itself) and so started developing PySide.
Both packages are wrapping the same library — Qt — and so share 99.9% of their API. But there is one major difference: licensing.
PyQt | PySide | |
---|---|---|
Current stable version (2019-06-23) | 6.1.1 | 6.1.2 |
First stable release | Apr 2016 | Jul 2018 |
Developed by | Riverbank Computing Ltd. | Qt |
License | GPL or commercial | LGPL |
Licensing is a confusing topic, so it's not surprising that it makes up the vast majority of questions I get about PySide vs. PyQt. In this short article I'll run through the most common questions and misconceptions about LGPL vs. GPL licensing and what it means for your applications.
Python itself is licensed under the PSF License (and a Zero-clause BSD license from 3.8.6 onwards). Neither license requires you to distribute your source code when distributing software created with Python, and the PSF only requires attribution when creating derivatives of Python itself.
What is the GPL?
The GNU General Public License (GPL) is a free software license that guarantees end users the freedom to run, study, share, and modify their software. The key mechanism by which it does this is by ensuring that end users have access to the source code of applications they receive (as binaries).
If you are planning to release your software itself under the GPL, or you are developing software which will not be distributed, the GPL requirement of PyQt5 is unlikely to be an issue. However, if you plan to distribute your software without distributing the source you will either need to purchase a commercial license from Riverbank for PyQt5 or use PySide2.
What is the LGPL
The GNU Lesser General Public License (LGPL) is another free-software license published by the Free Software Foundation (FSF). This license is modeled on the GPL but allows developers to use software components released under the LGPL in their own software, without being required to release their source code.
Packaging Python Applications with PyInstaller by Martin Fitzpatrick — This step-by-step guide walks you through packaging your own Python applications from simple examples to complete installers and signed executables.
The LGPL license does not require you to share the source code of your own applications, even if they are bundled with PySide2.
The LGPL does require you to distribute any changes you make to the PySide source code itself, but unless you're doing something very weird, you won't do this when making Python GUIs.
Can I use PyQt for commercial applications?
Yes. There is a common misunderstanding that you cannot use GPL licensed software in commercial applications. This isn't the case. The GPL does not prevent you from selling your software package, it merely requires you to share your source code with people who buy it.
If you use PyQt and don't want to release your source code to customers, you will need the Riverbank Commercial license.
Can I use PySide for commercial applications?
Yes, and you don't need to release your source code to customers. The LGPL only requires you to release any changes you make to PySide itself.
Why would someone buy my PyQt software if I'm giving away the source code?
Convenience. If you provide packaged installers for sale, the vast majority of people will want to use them rather than handle running/packaging the software from source themselves. That holds true even if your target audience is programmers: seriously, most people have better things to be doing with their time.
Again, note that the GPL only requires that you make the source code available to those people who receive the binary version. If you are selling your software this means you are only required to give the source to people who have bought the application. Many companies providing GPL software provide the source to everyone, but this is not a requirement of the GPL. It's just easier.
But my application contains super secret code!!! What then?
Then licensing is not the problem. While making the source code available of course makes it easier to read your super secrets, whether you provide the source or not you must assume your code is readable. Python bytecode is easier to reverse to readable source than compiled languages -- although that is still no real impediment to motivated hackers.
For security you have to assume that any code you provide to end users is accessible, readable and modifiable. Licensing is irrelevant: it's as effective a security measure as saying "please don't!"
Remember, you only need to give your source code to people who have bought the software. If they share your software with someone else, the distribution requirement is on them.
If your application relies on code that absolutely must not be accessible to your users, keep it on a server you control and provide an API to be used by your application. The GPL used by PyQt places no restrictions on doing this. Doing this also allows you to control licensing/access to your application's features, for subscription-type services if you wish.
Be aware though that this can be incredibly annoying for users, who might want to use your software offline or just have bad internet. Think really hard about whether your code is valuable enough to protect in this way. It probably isn't. Focus your time on building software people want to pay for.
Are there any other reasons to get a license?
Both Riverbank and Qt offer support to developers who buy their licenses.
I started using the wrong library? What now!?
You can very easily migrate from PyQt to PySide and vice versa. Take a look at my comparison and migration guide for PyQt and PySide.
Which should I use?
It's really up to you. The two key questions for more projects are --
- How much of an issue is it to distribute the application source code?
- Do you want to buy a license (or get paid support)?
- For the application you're building, can you find good tutorials/examples in the library you're using?
The latter usually favours starting with PyQt5: there are far more examples and tutorials available online because it's been around the longest. But my advice would be to get familiar -- as soon as possible -- with the differences so you can convert any code you find.
One more time for the people at the back
The key points again --
- PyQt5 is GPL licensed, PySide2 is LGPL licensed.
- Both licenses have no effect on whether you can sell your software commercially. You can sell GPL licensed software and LGPL licensed software.
- Both licenses may require you to share source code in specific circumstances, but LGPL is very unlikely to apply to a Python project.
For applications built with PyQt5 (GPL) if you distribute the software you must also make the source code of your software available to users (this doesn't mean making it publicly available, you can send it on request).
For applications build with PySide2 (LGPL) if you distribute the software you don't need to share the source of your application to your users. The one situation where you do need to share source when you modify the source of the LGPL library (PySide) itself. You normally won't be doing this while building Python apps.
Any questions? Get in touch.
Create GUI Applications with Python & Qt6 by Martin Fitzpatrick — (PySide6 Edition) The hands-on guide to making apps with Python — Over 10,000 copies sold!