PyOverlayKit


NamePyOverlayKit JSON
Version 0.2.0 PyPI version JSON
download
home_pagehttps://github.com/archiebhl/PyOverlayKit
SummaryA PyQt package for creating customizable always-on-top overlays, including when applications are full-screen.
upload_time2024-08-13 12:00:39
maintainerNone
docs_urlNone
authorNone
requires_python>=3.6
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # PyOverlayKit

This package provides a customizable overlay for PyQt applications, allowing you to create always-on-top windows with adjustable background colors, transparency, and layouts. Specifically, this package allows these overlays to stay on top of full-screened applications.

## Installation

You can install the package using pip:

`pip install PyOverlayKit`

## Example Usage
```
from PyQt6.QtWidgets import QApplication, QLabel, QPushButton, QGridLayout
from PyOverlayKit.overlay import Overlay
from PyQt6.QtGui import QColor

app = QApplication([])

overlay = Overlay()
overlay.set_background_color(QColor(0, 255, 0, 150))  # Green with 150 transparency
overlay.set_geometry(100, 100, 400, 200)

grid_layout = QGridLayout()
overlay.setLayout(grid_layout)

label1 = QLabel("Label 1")
button1 = QPushButton("Button 1")
grid_layout.addWidget(label1, 0, 0)
grid_layout.addWidget(button1, 0, 1)

overlay.show()
app.exec()
```

## Contributing
Contributions are welcome. Please fork the repository and submit a pull request.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/archiebhl/PyOverlayKit",
    "name": "PyOverlayKit",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/92/6f/c4cdb798bb3137867ff135dabfe2380d341cbce1416101536b50e7184fec/PyOverlayKit-0.2.0.tar.gz",
    "platform": null,
    "description": "# PyOverlayKit\r\n\r\nThis package provides a customizable overlay for PyQt applications, allowing you to create always-on-top windows with adjustable background colors, transparency, and layouts. Specifically, this package allows these overlays to stay on top of full-screened applications.\r\n\r\n## Installation\r\n\r\nYou can install the package using pip:\r\n\r\n`pip install PyOverlayKit`\r\n\r\n## Example Usage\r\n```\r\nfrom PyQt6.QtWidgets import QApplication, QLabel, QPushButton, QGridLayout\r\nfrom PyOverlayKit.overlay import Overlay\r\nfrom PyQt6.QtGui import QColor\r\n\r\napp = QApplication([])\r\n\r\noverlay = Overlay()\r\noverlay.set_background_color(QColor(0, 255, 0, 150))  # Green with 150 transparency\r\noverlay.set_geometry(100, 100, 400, 200)\r\n\r\ngrid_layout = QGridLayout()\r\noverlay.setLayout(grid_layout)\r\n\r\nlabel1 = QLabel(\"Label 1\")\r\nbutton1 = QPushButton(\"Button 1\")\r\ngrid_layout.addWidget(label1, 0, 0)\r\ngrid_layout.addWidget(button1, 0, 1)\r\n\r\noverlay.show()\r\napp.exec()\r\n```\r\n\r\n## Contributing\r\nContributions are welcome. Please fork the repository and submit a pull request.\r\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A PyQt package for creating customizable always-on-top overlays, including when applications are full-screen.",
    "version": "0.2.0",
    "project_urls": {
        "Homepage": "https://github.com/archiebhl/PyOverlayKit",
        "Repository": "https://github.com/archiebhl/PyOverlayKit"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7fbe0db93db4f2a45cb245cc26bdfba126305a54cf8e4f785c6f071e4cdd49d6",
                "md5": "d01a1e956957f63e4001695748b1e6d5",
                "sha256": "c4c39b3b3f3e4ed1a9cd8f6c89a7173f19a52e121bf13e3bbc75e02c30416c2a"
            },
            "downloads": -1,
            "filename": "PyOverlayKit-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d01a1e956957f63e4001695748b1e6d5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 3648,
            "upload_time": "2024-08-13T12:00:37",
            "upload_time_iso_8601": "2024-08-13T12:00:37.542995Z",
            "url": "https://files.pythonhosted.org/packages/7f/be/0db93db4f2a45cb245cc26bdfba126305a54cf8e4f785c6f071e4cdd49d6/PyOverlayKit-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "926fc4cdb798bb3137867ff135dabfe2380d341cbce1416101536b50e7184fec",
                "md5": "e3fdadfd8ec84738cf762079fc5f028f",
                "sha256": "a983ca4a0cb938bf3751708d1a0482af2f0dc148b82b71447454867dbea39e3c"
            },
            "downloads": -1,
            "filename": "PyOverlayKit-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "e3fdadfd8ec84738cf762079fc5f028f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 3221,
            "upload_time": "2024-08-13T12:00:39",
            "upload_time_iso_8601": "2024-08-13T12:00:39.162717Z",
            "url": "https://files.pythonhosted.org/packages/92/6f/c4cdb798bb3137867ff135dabfe2380d341cbce1416101536b50e7184fec/PyOverlayKit-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-13 12:00:39",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "archiebhl",
    "github_project": "PyOverlayKit",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "pyoverlaykit"
}
        
Elapsed time: 0.95152s