winipyside 2.0.1__py3-none-any.whl

winipyside-2.0.1.dist-info/METADATA

@@ -0,0 +1,284 @@
+Metadata-Version: 2.4
+Name: winipyside
+Version: 2.0.1
+Summary: A package for pyside utils
+Author: Winipedia
+Author-email: Winipedia <win.steveker@gmx.de>
+License-Expression: MIT
+Requires-Dist: pyqt-toast-notification
+Requires-Dist: pyside6
+Requires-Dist: winiutils
+Requires-Python: >=3.12, <3.14
+Description-Content-Type: text/markdown
+
+# winipyside
+
+(This project uses [pyrig](https://github.com/Winipedia/pyrig))
+
+A comprehensive PySide6 utilities package providing reusable components for building Qt desktop applications. Features include encrypted file I/O with AES-GCM, a full-featured media player with support for encrypted video playback, an embedded web browser with cookie management, toast notifications, and a modular page-based UI framework. Built with strict type safety and production-ready CI/CD workflows for headless environments.
+
+## Features
+
+### Core (`winipyside.src.core`)
+
+**Advanced QIODevice Wrappers for PySide6**
+
+- **`PyQIODevice`**: Python-friendly wrapper around Qt's QIODevice with enhanced functionality
+  - Provides clean Python interface to all QIODevice methods
+  - Seamless integration with PySide6's I/O system
+  - Support for sequential and random-access devices
+
+- **`PyQFile`**: File-specific wrapper extending PyQIODevice
+  - Simplified file operations with Path support
+  - Compatible with Qt's media framework
+
+- **`EncryptedPyQFile`**: Transparent AES-GCM encrypted file I/O
+  - **Chunked encryption** for efficient streaming of large files (64KB cipher chunks)
+  - **Position mapping** between encrypted and decrypted data for random access
+  - **Authenticated encryption** using AES-GCM with 12-byte nonces and 16-byte tags
+  - **Transparent decryption** - works seamlessly with Qt's QMediaPlayer for encrypted video playback
+  - Static methods for standalone encryption/decryption operations
+  - Secure random nonce generation per chunk
+  - Associated authenticated data (AAD) for additional security
+
+**Use Cases:**
+- Play encrypted media files without temporary decryption
+- Secure file storage with transparent access
+- Streaming large encrypted files with minimal memory overhead
+
+**Example:**
+
+```python
+from pathlib import Path
+from cryptography.hazmat.primitives.ciphers.aead import AESGCM
+from PySide6.QtCore import QUrl, QIODevice
+from PySide6.QtMultimedia import QMediaPlayer, QAudioOutput
+from winipyside.src.core.py_qiodevice import EncryptedPyQFile, PyQFile
+
+# Generate or load your encryption key
+key = AESGCM.generate_key(bit_length=256)
+aes_gcm = AESGCM(key)
+
+# Play an encrypted video file
+video_path = Path("encrypted_video.mp4")
+encrypted_file = EncryptedPyQFile(video_path, aes_gcm)
+encrypted_file.open(QIODevice.OpenModeFlag.ReadOnly)
+
+# Use with QMediaPlayer - decryption happens transparently
+player = QMediaPlayer()
+player.setAudioOutput(QAudioOutput())
+player.setSourceDevice(encrypted_file, QUrl.fromLocalFile(video_path))
+player.play()
+
+# Or use PyQFile for regular (unencrypted) files
+regular_file = PyQFile(Path("video.mp4"))
+regular_file.open(QIODevice.OpenModeFlag.ReadOnly)
+player.setSourceDevice(regular_file, QUrl.fromLocalFile("video.mp4"))
+```
+
+### UI Base (`winipyside.src.ui.base`)
+
+**Foundation Framework for Qt Applications**
+
+- **`Base`**: Abstract base class for all UI components with lifecycle management
+  - **Lifecycle hooks**: `base_setup()`, `pre_setup()`, `setup()`, `post_setup()`
+  - **Custom metaclass** (`QABCLoggingMeta`) combining ABC and Qt's metaclass for proper inheritance
+  - **Dynamic subclass discovery**: Automatically find and instantiate UI components
+  - **Page navigation**: Built-in methods for switching between pages in stacked layouts
+  - **SVG icon support**: Easy loading of SVG icons from resources
+  - **Display name generation**: Automatic human-readable names from class names
+
+**Example:**
+
+```python
+from winipyside.src.ui.base.base import Base
+from PySide6.QtWidgets import QWidget
+
+class MyCustomWidget(Base, QWidget):
+    def base_setup(self) -> None:
+        # Initialize Qt components
+        pass
+
+    def pre_setup(self) -> None:
+        # Setup before main initialization
+        pass
+
+    def setup(self) -> None:
+        # Main setup logic
+        self.setWindowTitle(self.get_display_name())  # "My Custom Widget"
+
+    def post_setup(self) -> None:
+        # Finalization after setup
+        pass
+
+# Discover all subclasses in your package
+all_widgets = MyCustomWidget.get_subclasses()
+```
+
+### UI Widgets (`winipyside.src.ui.widgets`)
+
+**Ready-to-Use Qt Widgets**
+
+- **`Notification`**: Toast notification system using pyqttoast
+  - **Auto-positioning**: Top-middle of screen
+  - **Smart text truncation**: Automatically fits text to window width
+  - **Customizable icons**: Information, warning, error, success
+  - **Duration control**: Configurable display time
+
+- **`ClickableWidget` / `ClickableVideoWidget`**: Click-enabled widgets
+  - **Signal emission**: Emits `clicked` signal on left mouse button press
+  - **Video widget variant**: Clickable QVideoWidget for media applications
+
+- **`Browser`**: Full-featured embedded web browser
+  - **Navigation controls**: Back, forward, address bar, go button
+  - **Cookie management**: Automatic cookie tracking and conversion
+  - **QNetworkCookie ↔ http.cookiejar.Cookie conversion**: Bridge Qt and Python cookie formats
+  - **Domain-based cookie access**: Retrieve cookies by domain
+  - **Auto-updates address bar**: Reflects current URL
+
+- **`MediaPlayer`**: Comprehensive media player widget
+  - **Playback controls**: Play/pause, speed adjustment (0.2x-5x), volume slider
+  - **Progress control**: Seekable progress bar with throttled updates
+  - **Fullscreen support**: Toggle fullscreen with automatic widget hiding
+  - **Encrypted playback**: Native support for `EncryptedPyQFile`
+  - **Clickable video**: Click to toggle control visibility
+  - **Position resumption**: Resume playback from specific positions
+  - **Smart resource management**: Proper cleanup of IO devices
+
+**Example:**
+
+```python
+from winipyside.src.ui.widgets.notification import Notification
+from winipyside.src.ui.widgets.media_player import MediaPlayer
+from winipyside.src.ui.widgets.browser import Browser
+from pyqttoast import ToastIcon
+from PySide6.QtWidgets import QVBoxLayout
+from pathlib import Path
+
+# Show a notification
+Notification(
+    title="Download Complete",
+    text="Your file has been downloaded successfully",
+    icon=ToastIcon.SUCCESS,
+    duration=5000
+)
+
+# Create a media player
+layout = QVBoxLayout()
+player = MediaPlayer(layout)
+player.play_file(Path("video.mp4"))
+
+# Or play encrypted file
+from cryptography.hazmat.primitives.ciphers.aead import AESGCM
+key = AESGCM.generate_key(bit_length=256)
+aes_gcm = AESGCM(key)
+player.play_encrypted_file(Path("encrypted.mp4"), aes_gcm)
+
+# Create a browser
+browser = Browser(layout)
+# Cookies are automatically tracked
+cookies = browser.get_domain_http_cookies("example.com")
+```
+
+### UI Pages (`winipyside.src.ui.pages`)
+
+**Page Components for Stacked Navigation**
+
+- **`pages.base.Base`**: Base page class for application pages
+  - **Menu dropdown**: Automatic navigation menu to all pages
+  - **Page switching**: Built-in methods to navigate between pages
+  - **Layout management**: Pre-configured vertical and horizontal layouts
+  - **Window integration**: Automatic registration with parent window
+
+- **`Player`**: Media player page
+  - **Abstract playback method**: Customizable `start_playback()` for your use case
+  - **Integrated MediaPlayer widget**: Full media player functionality
+  - **Encrypted file support**: Play encrypted videos with `play_encrypted_file()`
+  - **Auto page switching**: Automatically switches to player page on playback
+
+- **`Browser`**: Web browser page
+  - **Embedded browser widget**: Full web browsing capability
+  - **Cookie access**: Retrieve cookies from browsing sessions
+
+**Example:**
+
+```python
+from winipyside.src.ui.pages.player import Player
+from winipyside.src.ui.pages.browser import Browser
+from winipyside.src.ui.windows.base.base import Base as BaseWindow
+from pathlib import Path
+
+class MyPlayerPage(Player):
+    def start_playback(self, path: Path, position: int = 0) -> None:
+        # Custom playback logic
+        self.play_file(path, position)
+
+class MyWindow(BaseWindow):
+    @classmethod
+    def get_all_page_classes(cls):
+        return [MyPlayerPage, Browser]
+
+    @classmethod
+    def get_start_page_cls(cls):
+        return Browser
+
+    def pre_setup(self) -> None:
+        pass
+
+    def setup(self) -> None:
+        pass
+
+    def post_setup(self) -> None:
+        pass
+
+# Pages automatically get menu navigation between each other
+```
+
+### UI Windows (`winipyside.src.ui.windows`)
+
+**Main Window Framework**
+
+- **`windows.base.Base`**: Base window class (QMainWindow)
+  - **QStackedWidget integration**: Automatic page stacking and switching
+  - **Abstract page configuration**: Define pages via `get_all_page_classes()`
+  - **Start page selection**: Set initial page with `get_start_page_cls()`
+  - **Automatic page creation**: Pages are instantiated and added automatically
+  - **Window title**: Auto-generated from class name
+
+**Example:**
+
+```python
+from winipyside.src.ui.windows.base.base import Base as BaseWindow
+from winipyside.src.ui.pages.player import Player
+from winipyside.src.ui.pages.browser import Browser
+from PySide6.QtWidgets import QApplication
+
+class MyApp(BaseWindow):
+    @classmethod
+    def get_all_page_classes(cls):
+        return [Player, Browser]
+
+    @classmethod
+    def get_start_page_cls(cls):
+        return Browser
+
+    def pre_setup(self) -> None:
+        # Setup before pages are created
+        pass
+
+    def setup(self) -> None:
+        # Main window setup
+        self.resize(1280, 720)
+
+    def post_setup(self) -> None:
+        # Finalization
+        pass
+
+# Run the application
+app = QApplication([])
+window = MyApp()
+window.show()
+app.exec()
+```
+
+

winipyside-2.0.1.dist-info/RECORD

@@ -0,0 +1,52 @@
+winipyside/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipyside/dev/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipyside/dev/artifacts/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipyside/dev/artifacts/builder/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipyside/dev/artifacts/builder/builder.py,sha256=DdbLRMGQQdPgtYu8DSOZrw8Ukz5EmStSq4etgShh6_I,96
+winipyside/dev/artifacts/resources/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipyside/dev/artifacts/resources/delete_garbage_can.svg,sha256=UxEEh46w1JD4VViUBx-Ahaq5_ZR4zOjfeJn5_aM8114,318
+winipyside/dev/artifacts/resources/download_arrow.svg,sha256=8g_cBwKFHyoeSmaLMXcGwIHT4_rZDDtDGm35E0PkniE,242
+winipyside/dev/artifacts/resources/exit_fullscreen_icon.svg,sha256=sZSexEjab82zhAK3JRtOWH19aAFa1GhuGLChDz9wFFc,523
+winipyside/dev/artifacts/resources/fullscreen_icon.svg,sha256=mm2n6WvaSu0OqiQSAw0QPNwzXpPLaF53_XAklUfQQPo,406
+winipyside/dev/artifacts/resources/menu_icon.svg,sha256=pA1Z_x5gDkhYLQA0dL0l_8uBP-e6mKLcEOYwlhURUv4,344
+winipyside/dev/artifacts/resources/pause_icon.svg,sha256=z-Cj3DOI0rwRbWCOhaiHtDQYM4s6OgkCBVcdip77rQE,179
+winipyside/dev/artifacts/resources/play_icon.svg,sha256=7gx1EWZnyu1pA6WboAfVH3OGcp_uYPpT1syqHe-jaGE,953
+winipyside/dev/artifacts/resources/plus_icon.svg,sha256=1ucedu8ucLI7LMNsfNN2GYiwNUe8-ViNBcanDwzTqHc,552
+winipyside/dev/cli/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipyside/dev/cli/subcommands.py,sha256=iurWZwJwEKAfGpfjkn1YOhnRbIruCB4ouE-8R_Lh3JY,228
+winipyside/dev/configs/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipyside/dev/configs/configs.py,sha256=0J9bicIbKHVCpwd812fLJqTqM-h_nTdTc9u4fJtr5Kg,3404
+winipyside/dev/tests/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipyside/dev/tests/fixtures/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipyside/dev/tests/fixtures/fixture.py,sha256=fA8GaETQ0foL1CEqvmxf6ab2Wz-_CxxI-ttkj8CUmok,263
+winipyside/dev/tests/fixtures/scopes/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipyside/dev/tests/fixtures/scopes/class_.py,sha256=ZuI8_LEGy8SiutoygpgQq5_ojjlJRP-fNxDuhEzLj7M,417
+winipyside/dev/tests/fixtures/scopes/function.py,sha256=2ehbrDhtw581pKmvY0KvuDkPCma8E19TyZboOb80L2I,428
+winipyside/dev/tests/fixtures/scopes/module.py,sha256=OwdimjLzNMnsFT2th3OW5ZKP2YzjelC2NJ6jhSPrMMo,420
+winipyside/dev/tests/fixtures/scopes/package.py,sha256=yTDD_7UcWdml7uahvIQ4XQKVeVl-TqAAFtbe9t9VG9c,424
+winipyside/dev/tests/fixtures/scopes/session.py,sha256=MSN62vUCdpSPWBl9wYrEWu4qAmqwyINscgat2Rocp9M,423
+winipyside/main.py,sha256=-w752ghb91kXeuIO1rvOiN_nGypBpQqLCJxVqMBP82c,409
+winipyside/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+winipyside/src/__init__.py,sha256=4h5GWbLSKlFjaNIUbEAiX1wambPOxlE50TWTJnHGs3s,43
+winipyside/src/core/__init__.py,sha256=ymA82gqpwH4kISijecxTUN0J8GCbmkuIGTxq_vCNnnI,44
+winipyside/src/core/py_qiodevice.py,sha256=5onTJAE4Q328ACXrubZ2RsBO_PdJm0rXV6ZgqnzV4aU,15313
+winipyside/src/ui/__init__.py,sha256=f_Zr5JydpAkNrScLEFXOFvFNfvCKM39kQw_jq9-trFA,42
+winipyside/src/ui/base/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipyside/src/ui/base/base.py,sha256=57_UJq8wJHXB-0_lNDo_oMhFEpOztHKaoEvRq2uQPlE,5759
+winipyside/src/ui/pages/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipyside/src/ui/pages/base/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipyside/src/ui/pages/base/base.py,sha256=GKRVhvFVk6ofrBx9-Q353ItkVdHpakZuz5FqihVb5eg,2932
+winipyside/src/ui/pages/browser.py,sha256=YM5kCB-rBdQ_fKGb77tOJIjn9VRIyFdMNyhSeZIcaRM,792
+winipyside/src/ui/pages/player.py,sha256=CXUrganoWW_IHXXe3o7fjAYfZ_1xWW2FtbnhW0pIyfQ,2705
+winipyside/src/ui/widgets/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipyside/src/ui/widgets/browser.py,sha256=KFuICHUTX_8w5DfgJ3IbTu6ipuiuo-mTJku5tg-qSz0,8171
+winipyside/src/ui/widgets/clickable_widget.py,sha256=yMph7whLS6Bw65gf56LHdkZg-JzjWHUnSh3WW3IK25U,1722
+winipyside/src/ui/widgets/media_player.py,sha256=hIklO-1x4ry2L5TpaeyUtiE7FAfyvZ09gBT4R1kckBc,15752
+winipyside/src/ui/widgets/notification.py,sha256=UOm8ZaeWXkqtQtMqjsJ58noB5yOl-X_fId9PioabTug,2492
+winipyside/src/ui/windows/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipyside/src/ui/windows/base/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipyside/src/ui/windows/base/base.py,sha256=PuHBZlcKe7BGqu3hvkNi2BrE5kO3Z7-_JsKH7W6kV9E,1374
+winipyside-2.0.1.dist-info/WHEEL,sha256=3id4o64OvRm9dUknh3mMJNcfoTRK08ua5cU6DFyVy-4,79
+winipyside-2.0.1.dist-info/entry_points.txt,sha256=UHdZ1NF5NTI221PhwsZi4P-U1q7uIVozqStA-sw0it0,97
+winipyside-2.0.1.dist-info/METADATA,sha256=qkB-WZnjhbolxFdMMbuKbbUujXKg3QcgAq89s5P8r2M,9896
+winipyside-2.0.1.dist-info/RECORD,,

winipyside-2.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.9.13
+Root-Is-Purelib: true
+Tag: py3-none-any

winipyside-2.0.1.dist-info/entry_points.txt

@@ -0,0 +1,4 @@
+[console_scripts]
+winipedia-pyside = pyrig.dev.cli.cli:main
+winipyside = pyrig.dev.cli.cli:main
+