ezytools 0.2.0__tar.gz → 0.3.0__tar.gz

{ezytools-0.2.0 → ezytools-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: ezytools
-Version: 0.2.0
+Version: 0.3.0
 Summary: A Python utility library for Yapper bot developers
 License-Expression: LicenseRef-Proprietary
 License-File: LICENSE
@@ -451,3 +451,45 @@ Ezytools is a developing Python utility library focused on making bot developmen
 More utilities can be added as the library develops.
 
 
+
+
+## Voice shortcuts — 0.3.0
+
+Requires a Yapper SDK exposing `voice`, `move_member`, `disconnect_member`,
+`join_voice`, `leave_voice`, and (for audio) `connect_voice`.
+Existing utilities remain available. Implementations stay in `src/ezytools/core.py`.
+
+```python
+import ezytools as e
+
+members = e.voice_members(bot, server_id, channel_id)
+count = e.voice_member_count(bot, server_id, channel_id)
+current = e.member_voice_channel(bot, server_id, user_id)  # ID or None
+present = e.is_in_voice(bot, server_id, user_id)
+snapshot = e.voice_channels(bot, server_id)
+
+# Authorise the command user first (e.g. command_guard / require_roles).
+e.move_member(bot, server_id, user_id, destination_channel_id)
+e.disconnect_member(bot, server_id, user_id)
+e.move_members(bot, server_id, [user_id, other_id], destination_channel_id)
+e.disconnect_members(bot, server_id, [user_id, other_id])
+
+# A ticket alone does not connect audio; do not log its secret fields.
+ticket = e.join_voice(bot, server_id, channel_id)
+e.leave_voice(bot, server_id)
+
+# Inside an async function, with SDK audio dependencies installed:
+call = await e.connect_voice(bot, server_id, channel_id)
+try:
+    pass  # Use the SDK call.source to supply audio frames.
+finally:
+    await call.leave()
+```
+
+Moving requires a member already connected to voice; helpers cannot force
+someone to join a call. Server permissions and SDK errors still apply.
+Bulk actions validate all IDs first and deduplicate them; execution stops at
+the first failure, leaving earlier successful actions applied. Respect platform
+rate limits; there are no automatic retries or background moderation actions.
+Voice snapshots can change between lookup and action. Audio connections require
+the Yapper SDK's optional `livekit` and `cryptography` dependencies.