Skip to content

Commit a61d5bd

Browse files
Updated Python binding documentation with new PySide6 bindings
1 parent 225b1ff commit a61d5bd

File tree

1 file changed

+31
-9
lines changed

1 file changed

+31
-9
lines changed

README.md

Lines changed: 31 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![ukraine](doc/taiwan_ukraine.jpg)
1+
![ukraine](doc/ukraine.jpg)
22

33
![logo](doc/ads_logo.svg)
44

@@ -73,7 +73,9 @@ know it from Visual Studio.
7373
- [Tab-menu for easy handling of many tabbed dock widgets](#tab-menu-for-easy-handling-of-many-tabbed-dock-widgets)
7474
- [Many different ways to detach dock widgets](#many-different-ways-to-detach-dock-widgets)
7575
- [Supports deletion of dynamically created dock widgets](#supports-deletion-of-dynamically-created-dock-widgets)
76-
- [Python PyQt5 Bindings](#python-pyqt5-bindings)
76+
- [Python PyQt5 Bindings](#python-pyqt5-bindings)
77+
- [PySide6](#pyside6)
78+
- [PyQt5](#pyqt5)
7779
- [Tested Compatible Environments](#tested-compatible-environments)
7880
- [Supported Qt Versions](#supported-qt-versions)
7981
- [Windows](#windows)
@@ -180,21 +182,41 @@ You can detach dock widgets and also dock areas in the following ways:
180182

181183
Normally clicking the close button of a dock widget will just hide the widget and the user can show it again using the toggleView() action of the dock widget. This is meant for user interfaces with a static amount of widgets. But the advanced docking system also supports dynamic dock widgets that will get deleted on close. If you set the dock widget flag `DockWidgetDeleteOnClose` for a certain dock widget, then it will be deleted as soon as you close this dock widget. This enables the implementation of user interfaces with dynamically created editors, like in word processing applications or source code development tools.
182184

183-
### Python PyQt5 Bindings
185+
## Python PyQt5 Bindings
184186

185187
![Python Logo](doc/python_logo.png)
186188

187-
The Advanced Docking System comes with a complete Python integration based on
188-
PyQt5 bindings. The package is available via [conda-forge](https://github.com/conda-forge/pyqtads-feedstock). The python integration has been contributed to this project
189-
by the following people:
189+
Thanks to the contribution of several users, the Advanced Docking System comes
190+
with a complete Python integration. Python bindings are available for **PyQt5** and
191+
**PySide6**.
192+
193+
### PySide6
194+
195+
A PySide6 ADS package is available via PyPi and can be installed on Windows,
196+
macOS, and Linux with:
197+
198+
```bash
199+
pip install PySide6-QtAds
200+
```
201+
202+
Sample code is available [here](https://github.com/mborgerson/Qt-Advanced-Docking-System/tree/pyside6/examples). To run the samples, you'll also need to install latest qtpy
203+
from source (pip install https://github.com/spyder-ide/qtpy/archive/refs/heads/master.zip).
204+
The PySide6 bindings were contributed by:
205+
206+
- [mborgerson](https://github.com/mborgerson)
207+
208+
For more information about the PySide6 bindings read [this](https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System/issues/298) issue.
209+
210+
### PyQt5
211+
212+
A package is available via [conda-forge](https://github.com/conda-forge/pyqtads-feedstock).
213+
The python integration has been contributed to this project by the following people:
190214

191215
- [n-elie](https://github.com/n-elie)
192216
- [Hugo Slepicka](https://github.com/hhslepicka)
193217
- [K Lauer](https://github.com/klauer)
194218

195-
Latest working version: [3.5.2](https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System/releases/tag/3.5.2)
196-
197-
A Python integration is also availables via PyPi. You can install the
219+
A Python integration is also available via PyPi. You can install the
198220
[PyQtAds](https://pypi.org/project/PyQtAds/) package via pip. This feature has been
199221
contributed to this project by:
200222

0 commit comments

Comments
 (0)