README

PyQt-Fluent-Widgets


  A fluent design widgets library based on PyQt5












English | 简体中文 | 官网


!Interface


 Install
To install lite version for PyQt5:
shell
pip install PyQt-Fluent-Widgets -i https://pypi.org/simple/

Or install full-featured version (AcrylicLabel is  available):
shell
pip install "PyQt-Fluent-Widgets[full]" -i https://pypi.org/simple/


If you are using PySide2, PySide6 or PyQt6, you can download the code in PySide2, PySide6 or PyQt6 branch.

The Pro version library contains more advance components. You can download PyQt-Fluent-Widgets-Pro-Gallery.zip from the release page for preview purposes.

C++ QFluentWidgets require purchasing a license from the official website. You can also download the compiled demo C++_QFluentWidgets.zip from the release page.

 [!Warning]
 Don't install PyQt-Fluent-Widgets, PyQt6-Fluent-Widgets, PySide2-Fluent-Widgets and PySide6-Fluent-Widgets at the same time, because their package names are all qfluentwidgets.


 Run Example
After installing PyQt-Fluent-Widgets package using pip, you can run any demo in the examples directory, for example:
shell
cd examples/gallery
python demo.py


If you encounter ImportError: cannot import name 'XXX' from 'qfluentwidgets', it indicates that the package version you installed is too low. You can replace the mirror source with https://pypi.org/simple and reinstall again.

 Documentation
Want to know more about PyQt-Fluent-Widgets? Please read the help document 👈


 License
PyQt-Fluent-Widgets is licensed under GPLv3 for non-commercial project. For commercial use, please purchase a commercial license.

Copyright © 2021 by zhiyiYo.


 Work with Designer
Fluent Client integrates designer plugins, supporting direct drag-and-drop usage of QFluentWidgets components in Designer. You can purchase the client from TaoBao or Afdian.

!Fluent Designer

 Issue Reporting
If you encounter any problems while using the library, please first check the official documentation. If the issue is confirmed to be a bug in the library, please send the following information to [email protected]:

- Operating system information
- QFluentWidgets Library version
- Minimal reproducible code
- Steps to reproduce


 See Also
Here are some projects based on PyQt-Fluent-Widgets:
 zhiyiYo/Fluent-M3U8: A cross-platform m3u8 downloader
 zhiyiYo/Groove: A cross-platform music player based on PyQt5
 zhiyiYo/Alpha-Gobang-Zero: A gobang robot based on reinforcement learning

 Reference
 Windows design: Design guidelines and toolkits for creating native app experiences
 Microsoft/WinUI-Gallery: An app demonstrates the controls available in WinUI and the Fluent Design System