diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 51 |
1 files changed, 16 insertions, 35 deletions
@@ -1,6 +1,6 @@ # Qt For Python -Qt For Python is the [Python Qt bindings project](http://wiki.qt.io/PySide6), +Qt For Python is the [Python Qt bindings project](https://wiki.qt.io/PySide6), providing access to the complete Qt framework as well as to generator tools for rapidly generating bindings for any C++ libraries. @@ -24,16 +24,16 @@ The same setup.py script is used to build all the components of the project: * PySide6 Preferably, a Qt (build) environment should be used to automatically pick up -the associated `qmake`, but optionally one can specify the location of `qmake` +the associated `qtpaths6`, but optionally one can specify the location of `qtpaths6` and `cmake` if it is not in the current PATH with: - * `--qmake=/path/to/qt/bin/qmake`, and + * `--qtpaths=/path/to/qt/bin/qtpaths6`, and * `--cmake=/path/to/bin/cmake` respectively. By default, all of the above is built when no special options are passed to the -script. You can use the --build-type parameter to specify which things should +script. You can use the `--build-type` parameter to specify which things should be built: * `--build-type=shiboken6`, build/package only the python module @@ -61,40 +61,19 @@ are found by the QtNetwork module. ## Building Additional Options On Linux and macOS you can use the option `--standalone` to embed Qt libraries -into the PySide6 package. The option does not affect Windows, because it is +into the PySide6 package. The option does not affect Windows, because it is used implicitly, i.e. all relevant DLLs have to be copied into the PySide6 package anyway, because there is no proper rpath support on the platform. You can use the option `--rpath=/path/to/lib/path` to specify which rpath -values should be embedded into the PySide6 modules and shared libraries. This +values should be embedded into the PySide6 modules and shared libraries. This overrides the automatically generated values when the option is not specified. -You can use the option `--only-package` if you want to create more binary -packages (bdist_wheel, bdist_egg, ...) without rebuilding the entire project -every time: - -e.g.: - -* First, we create a bdist_wheel from a full PySide6 build: - ``` - python setup.py bdist_wheel --qmake=c:\Qt\6.0\bin\qmake.exe - --cmake=c:\tools\cmake\bin\cmake.exe - --openssl=c:\libs\OpenSSL32bit\bin - ``` -* Then, we create a bdist_egg reusing the PySide6 build with option - `--only-package`: - ``` - python setup.py bdist_egg --only-package - --qmake=c:\Qt\6.0\bin\qmake.exe - --cmake=c:\tools\cmake\bin\cmake.exe - --openssl=c:\libs\OpenSSL32bit\bin - ``` - You can use the option `--qt-conf-prefix` to pass a path relative to the PySide6 installed package, which will be embedded into an auto-generated -`qt.conf` registered in the Qt resource system. This path will serve as the +`qt.conf` registered in the Qt resource system. This path will serve as the PrefixPath for QLibraryInfo, thus allowing to choose where Qt plugins should be -loaded from. This option overrides the usual prefix chosen by `--standalone` +loaded from. This option overrides the usual prefix chosen by `--standalone` option, or when building on Windows. To temporarily disable registration of the internal `qt.conf` file, a new @@ -134,14 +113,16 @@ using `setup.py build`: or macOS only). * `--verbose-build`, will output the compiler invocation with command line arguments, etc. + * `--disable-pyi`, will suppress the generation of .pyi files. This allows + debugging when the project builds but the pyi generator complains. ## Requirements - * Python 3.6+ is supported, + * Python 3.9+ is supported (for Qt 6.7+) * CMake: Specify the path to cmake with `--cmake` option or add cmake to the system path. - * Qt 6.0+ is supported. Specify the path to qmake with `--qmake` option or - add qmake to the system path. + * Qt 6.x is supported. Specify the path to qtpaths with `--qtpaths` option or + add `qtpaths6` to the system path. ### Optional @@ -152,7 +133,7 @@ platforms. Please note that official Windows packages do not ship the OpenSSL libraries due to import/export restrictions as described in -http://doc.qt.io/qt-6/ssl.html#import-and-export-restrictions +https://doc.qt.io/qt-6/ssl.html#import-and-export-restrictions You can specify the location of the OpenSSL DLLs with the following option: `--openssl=</path/to/openssl/bin-directory>`. @@ -224,13 +205,13 @@ make sure to specify the following things: * `LLVM_INSTALL_DIR`, the environment variable should point to your libclang library location * `Qt`, either select a Qt Kit when configuring the project, or make sure that - the qmake binary is present in the PATH environment variable. + the `qtpaths6` binary is present in the PATH environment variable. * `Python`, the PATH environment variable should also point to the Python interpreter which you wish to use for building the projects (can either be a system interpreter, or a virtualenv one for example) Once that is done, just re-run CMake, so that it picks up the new environment -values. If needed, all other cache variables defined by the project files can +values. If needed, all other cache variables defined by the project files can be re-adjusted (for example FORCE_LIMITED_API). ## Command line CMake case |