PyQt-Fluent-Widgets


NamePyQt-Fluent-Widgets JSON
Version 1.5.5 PyPI version JSON
download
home_pagehttps://qfluentwidgets.com
SummaryA fluent design widgets library based on PyQt5
upload_time2024-04-13 06:44:46
maintainerNone
docs_urlNone
authorzhiyiYo
requires_pythonNone
licenseGPLv3
keywords pyqt fluent widgets
VCS
bugtrack_url
requirements PyQt5 PyQt5-Frameless-Window darkdetect colorthief scipy pillow
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            <p align="center">
  <img width="18%" align="center" src="https://raw.githubusercontent.com/zhiyiYo/PyQt-Fluent-Widgets/master/docs/source/_static/logo.png" alt="logo">
</p>
  <h1 align="center">
  PyQt-Fluent-Widgets
</h1>
<p align="center">
  A fluent design widgets library based on PyQt5
</p>

<p align="center">
  <a href="https://pypi.org/project/PyQt-Fluent-Widgets" target="_blank">
    <img src="https://img.shields.io/pypi/v/pyqt-fluent-widgets?color=%2334D058&label=Version" alt="Version">
  </a>

  <a style="text-decoration:none">
    <img src="https://static.pepy.tech/personalized-badge/pyqt-fluent-widgets?period=total&units=international_system&left_color=grey&right_color=brightgreen&left_text=Downloads" alt="Download"/>
  </a>

  <a style="text-decoration:none">
    <img src="https://img.shields.io/badge/License-GPLv3-blue?color=#4ec820" alt="GPLv3"/>
  </a>

  <a style="text-decoration:none">
    <img src="https://img.shields.io/badge/Platform-Win32%20|%20Linux%20|%20macOS-blue?color=#4ec820" alt="Platform Win32 | Linux | macOS"/>
  </a>
</p>

<p align="center">
English | <a href="docs/README_zh.md">简体中文</a> | <a href="https://qfluentwidgets.com/">官网</a>
</p>

![Interface](https://raw.githubusercontent.com/zhiyiYo/PyQt-Fluent-Widgets/master/docs/source/_static/Interface.jpg)


## Install
To install lite version (`AcrylicLabel` is not available):
```shell
pip install PyQt-Fluent-Widgets -i https://pypi.org/simple/
```
Or install full-featured version:
```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](https://github.com/zhiyiYo/PyQt-Fluent-Widgets/tree/PySide2), [PySide6](https://github.com/zhiyiYo/PyQt-Fluent-Widgets/tree/PySide6) or [PyQt6](https://github.com/zhiyiYo/PyQt-Fluent-Widgets/tree/PyQt6) branch.

The [Pro version](https://qfluentwidgets.com/pages/pro) library contains more advance components. You can download `PyQt-Fluent-Widgets-Pro-Gallery.zip` from the [release page](https://github.com/zhiyiYo/PyQt-Fluent-Widgets/releases) for preview purposes.

C++ QFluentWidgets require purchasing a license from the [official website](https://qfluentwidgets.com/price). You can also download the compiled demo `C++_QFluentWidgets.zip` from the [release page](https://github.com/zhiyiYo/PyQt-Fluent-Widgets/releases).

> **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:
```python
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](https://qfluentwidgets.com) 👈


## License
PyQt-Fluent-Widgets is licensed under [GPLv3](./LICENSE) for non-commercial project. For commercial use, please purchase a [commercial license](https://qfluentwidgets.com/price).

Copyright © 2021 by zhiyiYo.


## Video Demonstration
Check out this [▶ example video](https://www.bilibili.com/video/BV12c411L73q) that shows off what PyQt-Fluent-Widgets are capable of 🎉

## Work with Designer
[Fluent Client](https://www.youtube.com/watch?v=7UCmcsOlhTk) integrates designer plugins, supporting direct drag-and-drop usage of QFluentWidgets components in Designer. You can purchase the client from [Afadian](https://afdian.net/item/62cc7298cd9411eeb14d52540025c377) or [TaoBao](https://item.taobao.com/item.htm?ft=t&id=767961666600).

You can also create a new virtual environment to launch designer with plugins by running `python ./tools/designer.py`.

![Fluent Designer](https://img.fastmirror.net/s/2024/02/18/65d22363d4a73.jpg)


## See Also
Here are some projects based on PyQt-Fluent-Widgets:
* [**zhiyiYo/QMaterialWidgets**: A material design widgets library based on PyQt/PySide](https://qmaterialwidgets.vercel.app)
* [**zhiyiYo/Groove**: A cross-platform music player based on PyQt5](https://github.com/zhiyiYo/Groove)
* [**zhiyiYo/Alpha-Gobang-Zero**: A gobang robot based on reinforcement learning](https://github.com/zhiyiYo/Alpha-Gobang-Zero)

## Reference
* [**Windows design**: Design guidelines and toolkits for creating native app experiences](https://learn.microsoft.com/zh-cn/windows/apps/design/)
* [**Microsoft/WinUI-Gallery**: An app demonstrates the controls available in WinUI and the Fluent Design System](https://github.com/microsoft/WinUI-Gallery)

Raw data

            {
    "_id": null,
    "home_page": "https://qfluentwidgets.com",
    "name": "PyQt-Fluent-Widgets",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "pyqt fluent widgets",
    "author": "zhiyiYo",
    "author_email": "shokokawaii@outlook.com",
    "download_url": "https://files.pythonhosted.org/packages/eb/0c/51e355b68f62ea12891297c928d8623f99b1195fb7d4af9e30ffc2d028d5/PyQt-Fluent-Widgets-1.5.5.tar.gz",
    "platform": null,
    "description": "<p align=\"center\">\n  <img width=\"18%\" align=\"center\" src=\"https://raw.githubusercontent.com/zhiyiYo/PyQt-Fluent-Widgets/master/docs/source/_static/logo.png\" alt=\"logo\">\n</p>\n  <h1 align=\"center\">\n  PyQt-Fluent-Widgets\n</h1>\n<p align=\"center\">\n  A fluent design widgets library based on PyQt5\n</p>\n\n<p align=\"center\">\n  <a href=\"https://pypi.org/project/PyQt-Fluent-Widgets\" target=\"_blank\">\n    <img src=\"https://img.shields.io/pypi/v/pyqt-fluent-widgets?color=%2334D058&label=Version\" alt=\"Version\">\n  </a>\n\n  <a style=\"text-decoration:none\">\n    <img src=\"https://static.pepy.tech/personalized-badge/pyqt-fluent-widgets?period=total&units=international_system&left_color=grey&right_color=brightgreen&left_text=Downloads\" alt=\"Download\"/>\n  </a>\n\n  <a style=\"text-decoration:none\">\n    <img src=\"https://img.shields.io/badge/License-GPLv3-blue?color=#4ec820\" alt=\"GPLv3\"/>\n  </a>\n\n  <a style=\"text-decoration:none\">\n    <img src=\"https://img.shields.io/badge/Platform-Win32%20|%20Linux%20|%20macOS-blue?color=#4ec820\" alt=\"Platform Win32 | Linux | macOS\"/>\n  </a>\n</p>\n\n<p align=\"center\">\nEnglish | <a href=\"docs/README_zh.md\">\u7b80\u4f53\u4e2d\u6587</a> | <a href=\"https://qfluentwidgets.com/\">\u5b98\u7f51</a>\n</p>\n\n![Interface](https://raw.githubusercontent.com/zhiyiYo/PyQt-Fluent-Widgets/master/docs/source/_static/Interface.jpg)\n\n\n## Install\nTo install lite version (`AcrylicLabel` is not available):\n```shell\npip install PyQt-Fluent-Widgets -i https://pypi.org/simple/\n```\nOr install full-featured version:\n```shell\npip install \"PyQt-Fluent-Widgets[full]\" -i https://pypi.org/simple/\n```\n\nIf you are using PySide2, PySide6 or PyQt6, you can download the code in [PySide2](https://github.com/zhiyiYo/PyQt-Fluent-Widgets/tree/PySide2), [PySide6](https://github.com/zhiyiYo/PyQt-Fluent-Widgets/tree/PySide6) or [PyQt6](https://github.com/zhiyiYo/PyQt-Fluent-Widgets/tree/PyQt6) branch.\n\nThe [Pro version](https://qfluentwidgets.com/pages/pro) library contains more advance components. You can download `PyQt-Fluent-Widgets-Pro-Gallery.zip` from the [release page](https://github.com/zhiyiYo/PyQt-Fluent-Widgets/releases) for preview purposes.\n\nC++ QFluentWidgets require purchasing a license from the [official website](https://qfluentwidgets.com/price). You can also download the compiled demo `C++_QFluentWidgets.zip` from the [release page](https://github.com/zhiyiYo/PyQt-Fluent-Widgets/releases).\n\n> **Warning**\n> 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`.\n\n\n## Run Example\nAfter installing PyQt-Fluent-Widgets package using pip, you can run any demo in the examples directory, for example:\n```python\ncd examples/gallery\npython demo.py\n```\n\nIf 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.\n\n## Documentation\nWant to know more about PyQt-Fluent-Widgets? Please read the [help document](https://qfluentwidgets.com) \ud83d\udc48\n\n\n## License\nPyQt-Fluent-Widgets is licensed under [GPLv3](./LICENSE) for non-commercial project. For commercial use, please purchase a [commercial license](https://qfluentwidgets.com/price).\n\nCopyright \u00a9 2021 by zhiyiYo.\n\n\n## Video Demonstration\nCheck out this [\u25b6 example video](https://www.bilibili.com/video/BV12c411L73q) that shows off what PyQt-Fluent-Widgets are capable of \ud83c\udf89\n\n## Work with Designer\n[Fluent Client](https://www.youtube.com/watch?v=7UCmcsOlhTk) integrates designer plugins, supporting direct drag-and-drop usage of QFluentWidgets components in Designer. You can purchase the client from [Afadian](https://afdian.net/item/62cc7298cd9411eeb14d52540025c377) or [TaoBao](https://item.taobao.com/item.htm?ft=t&id=767961666600).\n\nYou can also create a new virtual environment to launch designer with plugins by running `python ./tools/designer.py`.\n\n![Fluent Designer](https://img.fastmirror.net/s/2024/02/18/65d22363d4a73.jpg)\n\n\n## See Also\nHere are some projects based on PyQt-Fluent-Widgets:\n* [**zhiyiYo/QMaterialWidgets**: A material design widgets library based on PyQt/PySide](https://qmaterialwidgets.vercel.app)\n* [**zhiyiYo/Groove**: A cross-platform music player based on PyQt5](https://github.com/zhiyiYo/Groove)\n* [**zhiyiYo/Alpha-Gobang-Zero**: A gobang robot based on reinforcement learning](https://github.com/zhiyiYo/Alpha-Gobang-Zero)\n\n## Reference\n* [**Windows design**: Design guidelines and toolkits for creating native app experiences](https://learn.microsoft.com/zh-cn/windows/apps/design/)\n* [**Microsoft/WinUI-Gallery**: An app demonstrates the controls available in WinUI and the Fluent Design System](https://github.com/microsoft/WinUI-Gallery)\n\n\n",
    "bugtrack_url": null,
    "license": "GPLv3",
    "summary": "A fluent design widgets library based on PyQt5",
    "version": "1.5.5",
    "project_urls": {
        "Bug Tracker": "https://github.com/zhiyiYo/PyQt-Fluent-Widgets/issues",
        "Documentation": "https://qfluentwidgets.com/",
        "Homepage": "https://qfluentwidgets.com",
        "Source Code": "https://github.com/zhiyiYo/PyQt-Fluent-Widgets"
    },
    "split_keywords": [
        "pyqt",
        "fluent",
        "widgets"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6da3edd68e6443d79d88bc0bf3c2c8166e56ed066b1b39d87f426ddc5e25ebdc",
                "md5": "d6de81685696adfc471fe463640cec4a",
                "sha256": "56a8acaf64b45770b9c3a665266f4c7ee851fbfca6d3f0467289404319243b08"
            },
            "downloads": -1,
            "filename": "PyQt_Fluent_Widgets-1.5.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d6de81685696adfc471fe463640cec4a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 1726216,
            "upload_time": "2024-04-13T06:44:42",
            "upload_time_iso_8601": "2024-04-13T06:44:42.651460Z",
            "url": "https://files.pythonhosted.org/packages/6d/a3/edd68e6443d79d88bc0bf3c2c8166e56ed066b1b39d87f426ddc5e25ebdc/PyQt_Fluent_Widgets-1.5.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "eb0c51e355b68f62ea12891297c928d8623f99b1195fb7d4af9e30ffc2d028d5",
                "md5": "9b43bc2e7daf288863eb84d77b4713e1",
                "sha256": "14dee9ae23beec15083b36dafa14aac8bb691c9a05c81acaca81a4a5598551cc"
            },
            "downloads": -1,
            "filename": "PyQt-Fluent-Widgets-1.5.5.tar.gz",
            "has_sig": false,
            "md5_digest": "9b43bc2e7daf288863eb84d77b4713e1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 1575384,
            "upload_time": "2024-04-13T06:44:46",
            "upload_time_iso_8601": "2024-04-13T06:44:46.026823Z",
            "url": "https://files.pythonhosted.org/packages/eb/0c/51e355b68f62ea12891297c928d8623f99b1195fb7d4af9e30ffc2d028d5/PyQt-Fluent-Widgets-1.5.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-13 06:44:46",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "zhiyiYo",
    "github_project": "PyQt-Fluent-Widgets",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "PyQt5",
            "specs": [
                [
                    ">=",
                    "5.15.0"
                ]
            ]
        },
        {
            "name": "PyQt5-Frameless-Window",
            "specs": [
                [
                    ">=",
                    "0.3.3"
                ]
            ]
        },
        {
            "name": "darkdetect",
            "specs": []
        },
        {
            "name": "colorthief",
            "specs": []
        },
        {
            "name": "scipy",
            "specs": []
        },
        {
            "name": "pillow",
            "specs": []
        }
    ],
    "lcname": "pyqt-fluent-widgets"
}
zhiyiYo
Elapsed time: 0.22768s