PyQt5-Frameless-Window


NamePyQt5-Frameless-Window JSON
Version 0.4.3 PyPI version JSON
download
home_pagehttps://github.com/zhiyiYo/PyQt-Frameless-Window
SummaryA cross-platform frameless window based on pyqt5, support Win32, X11, Wayland and macOS.
upload_time2024-08-21 03:33:27
maintainerNone
docs_urlNone
authorzhiyiYo
requires_pythonNone
licenseGPLv3
keywords pyqt frameless
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            <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">
  PyQt-Frameless-Window
</h1>
<p align="center">
  A cross-platform frameless window based on PyQt5
</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/pyqt5-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-GPLv3-blue?color=#4ec820" alt="GPLv3"/>
  </a>
</p>

![Cover](https://raw.githubusercontent.com/zhiyiYo/PyQt-Frameless-Window/master/screenshot/cover.jpg)


## Features
* Moving
* 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 PyQt5-Frameless-Window
```
Or clone the repo:
```shell
git clone https://github.com/zhiyiYo/PyQt-Frameless-Window.git
python setup.py install
```

## Requirements

| Platform | Requirement |
| :------: | :---------: |
|  Win32   |   pywin32   |
|  Linux   |   xcffib    |
|  MacOS   |   pyobjc    |


## Usage
To use the frameless window, you only need to inherit `FramelessWindow` or `FramelessMainWindow`. Here is a minimal example:
```python
import sys

from PyQt5.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/master/examples/demo.py) and [main_window.py](https://github.com/zhiyiYo/PyQt-Frameless-Window/blob/master/examples/main_window.py).

## Examples
* Normal frameless window
![Normal Frameless Window](https://raw.githubusercontent.com/zhiyiYo/PyQt-Frameless-Window/master/screenshot/normal_frameless_window.gif)
* Acrylic frameless window
![Acrylic Frameless Window](https://raw.githubusercontent.com/zhiyiYo/PyQt-Frameless-Window/master/screenshot/acrylic_window.jpg)


## Document
Want to know more about PyQt-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/master/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 PySide2, PySide6 or PyQt6, you can download the code in [PySide2](https://github.com/zhiyiYo/PyQt-Frameless-Window/tree/Pyside2), [PySide6](https://github.com/zhiyiYo/PyQt-Frameless-Window/tree/PySide6) or [PyQt6](https://github.com/zhiyiYo/PyQt-Frameless-Window/tree/PyQt6) branch.

## Support
If this project helps you a lot and you want to support the development and maintenance of this project, feel free to sponsor me via [爱发电](https://afdian.net/a/zhiyiYo) or [ko-fi](https://ko-fi.com/zhiyiYo). Your support is highly appreciated 🥰

## 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
PyQt-Frameless-Window is licensed under [GPLv3](./LICENSE).

Copyright © 2021 by zhiyiYo.

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/zhiyiYo/PyQt-Frameless-Window",
    "name": "PyQt5-Frameless-Window",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "pyqt frameless",
    "author": "zhiyiYo",
    "author_email": "shokokawaii@outlook.com",
    "download_url": "https://files.pythonhosted.org/packages/e3/55/a2ab00ba24fb44bcd47baadcabfc69c294ca247f31d74bfb950100387892/PyQt5-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  PyQt-Frameless-Window\n</h1>\n<p align=\"center\">\n  A cross-platform frameless window based on PyQt5\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/pyqt5-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-GPLv3-blue?color=#4ec820\" alt=\"GPLv3\"/>\n  </a>\n</p>\n\n![Cover](https://raw.githubusercontent.com/zhiyiYo/PyQt-Frameless-Window/master/screenshot/cover.jpg)\n\n\n## Features\n* Moving\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 PyQt5-Frameless-Window\n```\nOr clone the repo:\n```shell\ngit clone 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|  Linux   |   xcffib    |\n|  MacOS   |   pyobjc    |\n\n\n## Usage\nTo use the frameless window, you only need to inherit `FramelessWindow` or `FramelessMainWindow`. Here is a minimal example:\n```python\nimport sys\n\nfrom PyQt5.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/master/examples/demo.py) and [main_window.py](https://github.com/zhiyiYo/PyQt-Frameless-Window/blob/master/examples/main_window.py).\n\n## Examples\n* Normal frameless window\n![Normal Frameless Window](https://raw.githubusercontent.com/zhiyiYo/PyQt-Frameless-Window/master/screenshot/normal_frameless_window.gif)\n* Acrylic frameless window\n![Acrylic Frameless Window](https://raw.githubusercontent.com/zhiyiYo/PyQt-Frameless-Window/master/screenshot/acrylic_window.jpg)\n\n\n## Document\nWant to know more about PyQt-Frameless-Window? Please read the [help document](https://pyqt-frameless-window.readthedocs.io/) \ud83d\udc48\n\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/master/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 PySide2, PySide6 or PyQt6, you can download the code in [PySide2](https://github.com/zhiyiYo/PyQt-Frameless-Window/tree/Pyside2), [PySide6](https://github.com/zhiyiYo/PyQt-Frameless-Window/tree/PySide6) or [PyQt6](https://github.com/zhiyiYo/PyQt-Frameless-Window/tree/PyQt6) branch.\n\n## Support\nIf this project helps you a lot and you want to support the development and maintenance of this project, feel free to sponsor me via [\u7231\u53d1\u7535](https://afdian.net/a/zhiyiYo) or [ko-fi](https://ko-fi.com/zhiyiYo). Your support is highly appreciated \ud83e\udd70\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\nPyQt-Frameless-Window is licensed under [GPLv3](./LICENSE).\n\nCopyright \u00a9 2021 by zhiyiYo.\n",
    "bugtrack_url": null,
    "license": "GPLv3",
    "summary": "A cross-platform frameless window based on pyqt5, support Win32, X11, Wayland and macOS.",
    "version": "0.4.3",
    "project_urls": {
        "Homepage": "https://github.com/zhiyiYo/PyQt-Frameless-Window"
    },
    "split_keywords": [
        "pyqt",
        "frameless"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9c49cfc43901f921092de48849ce8c96d2a6c82239f8cd2a4b0a40c30ec35bb7",
                "md5": "7e4a57d7aa653f072b269c2239e761c9",
                "sha256": "f5f53cb10e5c32428139f2d8d299b1bacb6a029556e6e6e5b8fc25046d9398e3"
            },
            "downloads": -1,
            "filename": "PyQt5_Frameless_Window-0.4.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7e4a57d7aa653f072b269c2239e761c9",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 38871,
            "upload_time": "2024-08-21T03:33:25",
            "upload_time_iso_8601": "2024-08-21T03:33:25.559671Z",
            "url": "https://files.pythonhosted.org/packages/9c/49/cfc43901f921092de48849ce8c96d2a6c82239f8cd2a4b0a40c30ec35bb7/PyQt5_Frameless_Window-0.4.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e355a2ab00ba24fb44bcd47baadcabfc69c294ca247f31d74bfb950100387892",
                "md5": "b4e4cc86af0168d8e9fdfd771b2d0f0d",
                "sha256": "d0fb6d9bdf5a05cc45d41ffe0a05b08430b6ca87826d87e43995fd84105f8a74"
            },
            "downloads": -1,
            "filename": "PyQt5-Frameless-Window-0.4.3.tar.gz",
            "has_sig": false,
            "md5_digest": "b4e4cc86af0168d8e9fdfd771b2d0f0d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 32376,
            "upload_time": "2024-08-21T03:33:27",
            "upload_time_iso_8601": "2024-08-21T03:33:27.644516Z",
            "url": "https://files.pythonhosted.org/packages/e3/55/a2ab00ba24fb44bcd47baadcabfc69c294ca247f31d74bfb950100387892/PyQt5-Frameless-Window-0.4.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-21 03:33:27",
    "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": [],
    "lcname": "pyqt5-frameless-window"
}
zhiyiYo
Elapsed time: 0.29571s