Metadata-Version: 2.1
Name: PyOverlayKit
Version: 0.3.0
Summary: Always-on-top overlays for PyQt and PySide, including when applications are full-screen.
Home-page: https://github.com/archiebhl/PyOverlayKit
Project-URL: Repository, https://github.com/archiebhl/PyOverlayKit
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10.6
Description-Content-Type: text/markdown
Requires-Dist: pyqtgraph

# PyOverlayKit

This package provides a customizable overlay for PySide6/PyQt6 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 PySide6.QtWidgets import QApplication, QLabel, QPushButton, QGridLayout
from PySide6.QtGui import QColor
from PyOverlayKit.overlay import Overlay

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.
