<p align="center">
<img width="15%" align="center" src="https://raw.githubusercontent.com/zhiyiYo/PyQt-Frameless-Window/master/screenshot/logo.png" alt="logo">
</p>
<h1 align="center">
PySide2-Frameless-Window
</h1>
<p align="center">
A cross-platform frameless window based on PySide2
</p>
<p align="center">
<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>
<a style="text-decoration:none">
<img src="https://static.pepy.tech/personalized-badge/pyside2_frameless_window?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-LGPLv3-blue?color=#4ec820" alt="LGPLv3"/>
</a>
</p>
## Features
* Move
* Stretching
* Window shadow
* Window animation
* Win11 snap layout
* Win10 acrylic blur
* Win11 mica blur
* Win7 Aero blur
* MacOS blur
## Install
To install use pip:
```shell
pip install PySide2-Frameless-Window
```
Or clone the repo:
```shell
git clone -b Pyside2 https://github.com/zhiyiYo/PyQt-Frameless-Window.git
python setup.py install
```
## Requirements
| Platform | Requirement |
| :------: | :---------: |
| Win32 | pywin32 |
| MacOS | pyobjc |
## Usage
To use the frameless window, you only need to inherit `FramelessWindow`. Here is a minimal example:
```python
import sys
from PySide2.QtWidgets import QApplication
from qframelesswindow import FramelessWindow
class Window(FramelessWindow):
def __init__(self, parent=None):
super().__init__(parent=parent)
self.setWindowTitle("PyQt-Frameless-Window")
self.titleBar.raise_()
if __name__ == '__main__':
app = QApplication(sys.argv)
demo = Window()
demo.show()
sys.exit(app.exec_())
```
For more complex requirements, see [demo.py](https://github.com/zhiyiYo/PyQt-Frameless-Window/blob/Pyside2/examples/demo.py) and [main_window.py](https://github.com/zhiyiYo/PyQt-Frameless-Window/blob/Pyside2/examples/main_window.py).
## Examples
* Normal frameless window
* Acrylic frameless window
## Document
Want to know more about PySide2-Frameless-Window? Please read the [help document](https://pyqt-frameless-window.readthedocs.io/) 👈
## Notes
1. `FramelessWindow` provides a default custom title bar. If you don't like it, just rewrite it as [demo.py](https://github.com/zhiyiYo/PyQt-Frameless-Window/blob/Pyside2/examples/demo.py) does.
2. Moving the acrylic window on Win10 may get stuck. At present, there is no good solution. Maybe you can disable the acrylic effect when moving the window, but I haven't done this in the source code.
3. Snap layout is not enabled by default. See [#56](https://github.com/zhiyiYo/PyQt-Frameless-Window/issues/56) to learn how to enable it.
4. If you encounter this problem on Windows:
> ImportError: DLL load failed while importing win32api
see my answer on [stackoverflow](https://stackoverflow.com/questions/58612306/how-to-fix-importerror-dll-load-failed-while-importing-win32api/72488468#72488468) or my [blog](https://www.cnblogs.com/zhiyiYo/p/16340429.html) for the solution.
5. If you are using PyQt5, PyQt6 or PySide6, you can download the code in [PyQt5](https://github.com/zhiyiYo/PyQt-Frameless-Window) or [PyQt6](https://github.com/zhiyiYo/PyQt-Frameless-Window/tree/PyQt6) or [PySide6](https://github.com/zhiyiYo/PyQt-Frameless-Window/tree/PySide6) branch.
## See Also
Here are some projects that use PyQt-Frameless-Window:
* [**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)
* [**zhiyiYo/PyQt-Fluent-Widgets**: A fluent design widgets library based on Qt](https://github.com/zhiyiYo/PyQt-Fluent-Widgets)
* [**zhiyiYo/QMaterialWidgets**: A material design widgets library based on Qt](https://qmaterialwidgets.vercel.app)
## Reference
* [**wangwenx190/framelesshelper**: Frameless windows for Qt Widgets and Qt Quick applications. Support Win32, X11, Wayland and macOS](https://github.com/wangwenx190/framelesshelper)
* [**libxcb**: Basic Graphics Programming With The XCB Library](https://www.x.org/releases/X11R7.5/doc/libxcb/tutorial)
## License
PySide2-Frameless-Window is licensed under [LGPLv3](./LICENSE).
Copyright © 2021 by zhiyiYo.
Raw data
{
"_id": null,
"home_page": "https://github.com/zhiyiYo/PyQt-Frameless-Window/tree/Pyside2",
"name": "PySide2-Frameless-Window",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "pyside2 frameless",
"author": "zhiyiYo",
"author_email": "shokokawaii@outlook.com",
"download_url": "https://files.pythonhosted.org/packages/c9/a2/181803c498d22fb490ca13ea32e48ec8ab9589ef8b6f27826a6cab3d3f41/PySide2-Frameless-Window-0.4.3.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <img width=\"15%\" align=\"center\" src=\"https://raw.githubusercontent.com/zhiyiYo/PyQt-Frameless-Window/master/screenshot/logo.png\" alt=\"logo\">\n</p>\n <h1 align=\"center\">\n PySide2-Frameless-Window\n</h1>\n<p align=\"center\">\n A cross-platform frameless window based on PySide2\n</p>\n\n<p align=\"center\">\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\n <a style=\"text-decoration:none\">\n <img src=\"https://static.pepy.tech/personalized-badge/pyside2_frameless_window?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-LGPLv3-blue?color=#4ec820\" alt=\"LGPLv3\"/>\n </a>\n</p>\n\n\n\n\n## Features\n* Move\n* Stretching\n* Window shadow\n* Window animation\n* Win11 snap layout\n* Win10 acrylic blur\n* Win11 mica blur\n* Win7 Aero blur\n* MacOS blur\n\n## Install\nTo install use pip:\n```shell\npip install PySide2-Frameless-Window\n```\nOr clone the repo:\n```shell\ngit clone -b Pyside2 https://github.com/zhiyiYo/PyQt-Frameless-Window.git\npython setup.py install\n```\n\n## Requirements\n\n| Platform | Requirement |\n| :------: | :---------: |\n| Win32 | pywin32 |\n| MacOS | pyobjc |\n\n\n## Usage\nTo use the frameless window, you only need to inherit `FramelessWindow`. Here is a minimal example:\n```python\nimport sys\n\nfrom PySide2.QtWidgets import QApplication\nfrom qframelesswindow import FramelessWindow\n\n\nclass Window(FramelessWindow):\n\n def __init__(self, parent=None):\n super().__init__(parent=parent)\n self.setWindowTitle(\"PyQt-Frameless-Window\")\n self.titleBar.raise_()\n\n\nif __name__ == '__main__':\n app = QApplication(sys.argv)\n demo = Window()\n demo.show()\n sys.exit(app.exec_())\n```\nFor more complex requirements, see [demo.py](https://github.com/zhiyiYo/PyQt-Frameless-Window/blob/Pyside2/examples/demo.py) and [main_window.py](https://github.com/zhiyiYo/PyQt-Frameless-Window/blob/Pyside2/examples/main_window.py).\n\n## Examples\n* Normal frameless window\n\n* Acrylic frameless window\n\n\n\n## Document\nWant to know more about PySide2-Frameless-Window? Please read the [help document](https://pyqt-frameless-window.readthedocs.io/) \ud83d\udc48\n\n## Notes\n1. `FramelessWindow` provides a default custom title bar. If you don't like it, just rewrite it as [demo.py](https://github.com/zhiyiYo/PyQt-Frameless-Window/blob/Pyside2/examples/demo.py) does.\n\n2. Moving the acrylic window on Win10 may get stuck. At present, there is no good solution. Maybe you can disable the acrylic effect when moving the window, but I haven't done this in the source code.\n3. Snap layout is not enabled by default. See [#56](https://github.com/zhiyiYo/PyQt-Frameless-Window/issues/56) to learn how to enable it.\n\n4. If you encounter this problem on Windows:\n > ImportError: DLL load failed while importing win32api\n\n see my answer on [stackoverflow](https://stackoverflow.com/questions/58612306/how-to-fix-importerror-dll-load-failed-while-importing-win32api/72488468#72488468) or my [blog](https://www.cnblogs.com/zhiyiYo/p/16340429.html) for the solution.\n\n5. If you are using PyQt5, PyQt6 or PySide6, you can download the code in [PyQt5](https://github.com/zhiyiYo/PyQt-Frameless-Window) or [PyQt6](https://github.com/zhiyiYo/PyQt-Frameless-Window/tree/PyQt6) or [PySide6](https://github.com/zhiyiYo/PyQt-Frameless-Window/tree/PySide6) branch.\n\n## See Also\nHere are some projects that use PyQt-Frameless-Window:\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* [**zhiyiYo/PyQt-Fluent-Widgets**: A fluent design widgets library based on Qt](https://github.com/zhiyiYo/PyQt-Fluent-Widgets)\n* [**zhiyiYo/QMaterialWidgets**: A material design widgets library based on Qt](https://qmaterialwidgets.vercel.app)\n\n## Reference\n* [**wangwenx190/framelesshelper**: Frameless windows for Qt Widgets and Qt Quick applications. Support Win32, X11, Wayland and macOS](https://github.com/wangwenx190/framelesshelper)\n* [**libxcb**: Basic Graphics Programming With The XCB Library](https://www.x.org/releases/X11R7.5/doc/libxcb/tutorial)\n\n## License\nPySide2-Frameless-Window is licensed under [LGPLv3](./LICENSE).\n\nCopyright \u00a9 2021 by zhiyiYo.\n",
"bugtrack_url": null,
"license": "LGPLv3",
"summary": "A cross-platform frameless window based on pyside2, support Win32, Linux and macOS.",
"version": "0.4.3",
"project_urls": {
"Homepage": "https://github.com/zhiyiYo/PyQt-Frameless-Window/tree/Pyside2"
},
"split_keywords": [
"pyside2",
"frameless"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7b852de1e70ffb059d6e6c311c19b34472bc7174915e5ffe9a039fc0387f6402",
"md5": "ca0ce4b9a1f0fcc9afa8541c4396c2a4",
"sha256": "ee114fdb80612b948fe8d294ca413cba9e93155b5cf03699ecffa3d1430fec8f"
},
"downloads": -1,
"filename": "PySide2_Frameless_Window-0.4.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ca0ce4b9a1f0fcc9afa8541c4396c2a4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 28153,
"upload_time": "2024-08-21T03:47:04",
"upload_time_iso_8601": "2024-08-21T03:47:04.228120Z",
"url": "https://files.pythonhosted.org/packages/7b/85/2de1e70ffb059d6e6c311c19b34472bc7174915e5ffe9a039fc0387f6402/PySide2_Frameless_Window-0.4.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c9a2181803c498d22fb490ca13ea32e48ec8ab9589ef8b6f27826a6cab3d3f41",
"md5": "e52e6290a3719c0a2a5f7d6522f35baa",
"sha256": "d2900fdda57a07d6f656f877ba7fc7494dfb3346f2411a10744046a9bb5569de"
},
"downloads": -1,
"filename": "PySide2-Frameless-Window-0.4.3.tar.gz",
"has_sig": false,
"md5_digest": "e52e6290a3719c0a2a5f7d6522f35baa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 21337,
"upload_time": "2024-08-21T03:47:06",
"upload_time_iso_8601": "2024-08-21T03:47:06.887157Z",
"url": "https://files.pythonhosted.org/packages/c9/a2/181803c498d22fb490ca13ea32e48ec8ab9589ef8b6f27826a6cab3d3f41/PySide2-Frameless-Window-0.4.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-21 03:47:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zhiyiYo",
"github_project": "PyQt-Frameless-Window",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "pywin32",
"specs": [
[
"==",
"227"
]
]
},
{
"name": "xcffib",
"specs": [
[
"==",
"0.11.1"
]
]
},
{
"name": "pyobjc",
"specs": []
},
{
"name": "PyCocoa",
"specs": []
}
],
"lcname": "pyside2-frameless-window"
}
JSON
