tryx 1.0.3__tar.gz → 1.3.2__tar.gz

tryx-1.3.2/.github/workflows/docs.yml

@@ -0,0 +1,206 @@
+name: Documentation
+
+on:
+  push:
+    branches: [master, main]
+    paths:
+      - "docs/**"
+      - "mkdocs.yml"
+      - "python/tryx/**"
+
+  pull_request:
+    branches: [master, main]
+    paths:
+      - "docs/**"
+      - "mkdocs.yml"
+      - "python/tryx/**"
+
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "Version to deploy (e.g. 0.7, 0.8)"
+        required: false
+        type: string
+      delete_version:
+        description: "Version to delete"
+        required: false
+        type: string
+
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+concurrency:
+  group: docs-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  # ── Job 1: Validate (runs on PR + push) ────────────────────────────────────
+  validate:
+    name: Validate Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - uses: astral-sh/setup-uv@v5
+
+      - name: Install dependencies
+        run: |
+          uv sync --group docs --no-install-project
+          uv pip install pyright mypy --system
+
+      - name: Validate .pyi stubs with pyright
+        run: |
+          pyright python/tryx/client.pyi \
+                 python/tryx/events.pyi \
+                 python/tryx/types.pyi \
+                 python/tryx/wacore.pyi \
+                 python/tryx/helpers.pyi \
+                 python/tryx/backend.pyi \
+                 python/tryx/exceptions.pyi \
+                 python/tryx/__init__.pyi \
+                 python/tryx/tryx.pyi \
+                 python/tryx/media.pyi
+
+      - name: Validate .pyi stubs with mypy
+        run: |
+          mypy python/tryx/client.pyi \
+               python/tryx/events.pyi \
+               python/tryx/types.pyi \
+               python/tryx/wacore.pyi \
+               python/tryx/helpers.pyi \
+               python/tryx/backend.pyi \
+               python/tryx/exceptions.pyi \
+               python/tryx/__init__.pyi \
+               python/tryx/tryx.pyi \
+               python/tryx/media.pyi \
+               --ignore-missing-imports
+
+      - name: Build docs (validation only)
+        run: uv run --no-project mkdocs build --strict
+        env:
+          PYTHONPATH: python
+
+  # ── Job 2: Deploy (runs on push to master or tag) ──────────────────────────
+  deploy:
+    name: Deploy Documentation
+    needs: validate
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push'
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          submodules: recursive
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - uses: astral-sh/setup-uv@v5
+
+      - name: Install dependencies
+        run: |
+          uv sync --group docs --no-install-project
+          uv pip install mike
+
+      - name: Configure git
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+      # Auto-deploy from tag → versioned docs (e.g. v0.8.0 → "0.8")
+      - name: Deploy versioned docs (from tag)
+        if: startsWith(github.ref, 'refs/tags/v')
+        run: |
+          VERSION=$(echo "${{ github.ref_name }}" | sed 's/^v//' | sed 's/\.[0-9]*$//')
+          echo "Deploying docs for version: $VERSION"
+          uv run --no-project mike deploy --push --update-aliases "$VERSION" latest
+          uv run --no-project mike set-default --push latest
+        env:
+          PYTHONPATH: python
+
+      # Auto-deploy from master → "latest" (without version number)
+      - name: Deploy latest docs (from master)
+        if: "!startsWith(github.ref, 'refs/tags/')"
+        run: |
+          echo "Deploying docs as latest"
+          uv run --no-project mike deploy --push --update-aliases dev latest
+          uv run --no-project mike set-default --push latest
+        env:
+          PYTHONPATH: python
+
+      - name: List deployed versions
+        if: success()
+        run: uv run --no-project mike list
+
+  # ── Job 3: Manual deploy (workflow_dispatch) ────────────────────────────────
+  manual_deploy:
+    name: Manual Deploy
+    runs-on: ubuntu-latest
+    if: github.event_name == 'workflow_dispatch'
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          submodules: recursive
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - uses: astral-sh/setup-uv@v5
+
+      - name: Install dependencies
+        run: |
+          uv sync --group docs --no-install-project
+          uv pip install mike
+
+      - name: Configure git
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+      # Deploy custom version
+      - name: Deploy custom version
+        if: inputs.version != ''
+        run: |
+          echo "Deploying docs for version: ${{ inputs.version }}"
+          uv run --no-project mike deploy --push --update-aliases "${{ inputs.version }}" latest
+          uv run --no-project mike set-default --push latest
+        env:
+          PYTHONPATH: python
+
+      # Delete a version
+      - name: Delete docs version
+        if: inputs.delete_version != ''
+        run: |
+          echo "Deleting docs version: ${{ inputs.delete_version }}"
+          uv run --no-project mike delete --push "${{ inputs.delete_version }}"
+        env:
+          PYTHONPATH: python
+
+      - name: List deployed versions
+        if: success()
+        run: uv run --no-project mike list
+
+  # ── Job 4: Deploy to GitHub Pages (only for tag releases) ──────────────────
+  deploy_pages:
+    name: Deploy to GitHub Pages
+    needs: deploy
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

{tryx-1.0.3 → tryx-1.3.2}/.pre-commit-config.yaml

@@ -25,6 +25,14 @@ repos:
         language: system
         types_or: [python, pyi]
 
+      - id: pyright
+        name: pyright type check
+        entry: uv run pyright
+        language: system
+        types: [python]
+        pass_filenames: false
+        files: "^python/tryx/.*\\.(py|pyi)$"
+
       - id: stub-parity
         name: check stub parity
         entry: uv run python scripts/check_stub_parity.py

{tryx-1.0.3 → tryx-1.3.2}/Cargo.lock

@@ -2766,7 +2766,7 @@ dependencies = [
 
 [[package]]
 name = "tryx"
-version = "1.0.3"
+version = "1.3.2"
 dependencies = [
  "async-channel",
  "async-trait",

{tryx-1.0.3 → tryx-1.3.2}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "tryx"
-version = "1.0.3"
+version = "1.3.2"
 edition = "2024"
 readme = "README.md"
 
@@ -68,3 +68,10 @@ panic = "abort"       # skip unwind tables (~5% smaller)
 [profile.dev]
 # Keep dev builds fast.
 opt-level = 0
+
+# Profile for stubs generation: fast compile, no optimization needed.
+[profile.stubs]
+inherits = "dev"
+opt-level = 0
+strip = false
+lto = false

{tryx-1.0.3 → tryx-1.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tryx
-Version: 1.0.3
+Version: 1.3.2
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
@@ -108,7 +108,9 @@ async def on_pairing_qr(_client: TryxClient, event: EvPairingQrCode) -> None:
 async def on_message(client: TryxClient, event: EvMessage) -> None:
     text = (event.data.get_text() or "").strip()
     if text.lower() == "ping":
-        await client.send_text(event.data.message_info.source.chat, "pong", quoted=event)
+        await client.send_text(
+            event.data.message_info.source.chat, "pong", quoted=event
+        )
 
 
 async def main() -> None:
@@ -182,11 +184,15 @@ AudioSource.frames() must yield exactly 1,920 bytes per frame. AudioSink.write()
 ```python
 from collections.abc import AsyncIterator
 from tryx.media import AudioSink, AudioSource, validate_audio_frame
+
+
 class Microphone(AudioSource):
     async def frames(self) -> AsyncIterator[bytes]:
         while True:
             frame = await read_microphone_frame()
             yield validate_audio_frame(frame)
+
+
 class Speaker(AudioSink):
     async def write(self, frame: bytes) -> None:
         validate_audio_frame(frame)
@@ -199,6 +205,8 @@ Replace the two backend functions with PyAudio, sounddevice, ALSA, CoreAudio, or
 
 ```python
 from tryx.types import JID
+
+
 async def start_audio_call(client, phone_number: str):
     peer = JID(phone_number + "@s.whatsapp.net")
     call = await client.voip.call(peer, Microphone(), Speaker())
@@ -212,6 +220,8 @@ Use await call.hangup() to end a call explicitly. Keep the CallHandle alive and
 #### Video Call
 ```python
 from tryx.media import VideoPlayer
+
+
 async def start_video_call(client, peer, video_sink):
     video_source = VideoPlayer(fps=15)
     video_source.play("sample.mp4")
@@ -261,6 +271,7 @@ Use the incoming-call event exported by the installed package version.
 AudioPlayer decodes files in Rust and normalizes them to mono PCM16 at 16 kHz.
 ```python
 from tryx.media import AudioPlayer
+
 player = AudioPlayer(buffer_frames=3)
 player.play("intro.mp3", mode="replace")
 call = await client.voip.call(peer, player, Speaker())
@@ -387,7 +398,9 @@ async def on_pairing_qr(_client: TryxClient, event: EvPairingQrCode) -> None:
 async def on_message(client: TryxClient, event: EvMessage) -> None:
     text = (event.data.get_text() or "").strip()
     if text.lower() == "ping":
-        await client.send_text(event.data.message_info.source.chat, "pong", quoted=event)
+        await client.send_text(
+            event.data.message_info.source.chat, "pong", quoted=event
+        )
 
 
 async def main() -> None:
@@ -462,11 +475,15 @@ AudioSource.frames() 必须每次产生恰好 1,920 字节。AudioSink.write()
 ```python
 from collections.abc import AsyncIterator
 from tryx.media import AudioSink, AudioSource, validate_audio_frame
+
+
 class Microphone(AudioSource):
     async def frames(self) -> AsyncIterator[bytes]:
         while True:
             frame = await read_microphone_frame()
             yield validate_audio_frame(frame)
+
+
 class Speaker(AudioSink):
     async def write(self, frame: bytes) -> None:
         validate_audio_frame(frame)
@@ -478,6 +495,8 @@ class Speaker(AudioSink):
 
 ```python
 from tryx.types import JID
+
+
 async def start_audio_call(client, phone_number: str):
     peer = JID(phone_number + "@s.whatsapp.net")
     call = await client.voip.call(peer, Microphone(), Speaker())
@@ -491,6 +510,8 @@ async def start_audio_call(client, phone_number: str):
 #### 视频通话
 ```python
 from tryx.media import VideoPlayer
+
+
 async def start_video_call(client, peer, video_sink):
     video_source = VideoPlayer(fps=15)
     video_source.play("sample.mp4")
@@ -540,6 +561,7 @@ async def on_incoming_call(_client, event):
 AudioPlayer 在 Rust 中解码文件，并将其标准化为 16 kHz 单声道 PCM16。
 ```python
 from tryx.media import AudioPlayer
+
 player = AudioPlayer(buffer_frames=3)
 player.play("intro.mp3", mode="replace")
 call = await client.voip.call(peer, player, Speaker())
@@ -652,7 +674,9 @@ async def on_pairing_qr(_client: TryxClient, event: EvPairingQrCode) -> None:
 async def on_message(client: TryxClient, event: EvMessage) -> None:
     text = (event.data.get_text() or "").strip()
     if text.lower() == "ping":
-        await client.send_text(event.data.message_info.source.chat, "pong", quoted=event)
+        await client.send_text(
+            event.data.message_info.source.chat, "pong", quoted=event
+        )
 
 
 async def main() -> None:
@@ -723,48 +747,52 @@ AudioSource.frames() harus menghasilkan async iterator dengan tepat 1.920 byte u
 
 #### Adapter Audio Minimal
 ```python
-    from collections.abc import AsyncIterator
-    from tryx.media import AudioSink, AudioSource, validate_audio_frame
+from collections.abc import AsyncIterator
+from tryx.media import AudioSink, AudioSource, validate_audio_frame
+
 
-    class Microphone(AudioSource):
-        async def frames(self) -> AsyncIterator[bytes]:
-            while True:
-                frame = await read_microphone_frame()
-                yield validate_audio_frame(frame)
+class Microphone(AudioSource):
+    async def frames(self) -> AsyncIterator[bytes]:
+        while True:
+            frame = await read_microphone_frame()
+            yield validate_audio_frame(frame)
 
-    class Speaker(AudioSink):
-        async def write(self, frame: bytes) -> None:
-            validate_audio_frame(frame)
-            await play_speaker_frame(frame)
+
+class Speaker(AudioSink):
+    async def write(self, frame: bytes) -> None:
+        validate_audio_frame(frame)
+        await play_speaker_frame(frame)
 ```
 Ganti fungsi perangkat tersebut dengan implementasi PyAudio, sounddevice, ALSA, CoreAudio, atau library perangkat lain.
 
 #### Panggilan Audio 1:1
 ```python
-    from tryx.types import JID
-
-    async def start_audio_call(client, phone_number: str):
-        peer = JID(phone_number + "@s.whatsapp.net")
-        call = await client.voip.call(peer, Microphone(), Speaker())
-        print("call started:", call.call_id)
-        call.set_muted(True)
-        call.set_muted(False)
-        await call.wait_ended()
+from tryx.types import JID
+
+
+async def start_audio_call(client, phone_number: str):
+    peer = JID(phone_number + "@s.whatsapp.net")
+    call = await client.voip.call(peer, Microphone(), Speaker())
+    print("call started:", call.call_id)
+    call.set_muted(True)
+    call.set_muted(False)
+    await call.wait_ended()
 ```
 Gunakan await call.hangup() untuk mengakhiri call secara eksplisit. Pertahankan CallHandle selama call aktif dan tunggu wait_ended() agar cleanup media berjalan deterministik.
 
 #### Panggilan Video
 ```python
-    from tryx.media import VideoPlayer
+from tryx.media import VideoPlayer
 
-    async def start_video_call(client, peer, video_sink):
-        video_source = VideoPlayer(fps=15)
-        video_source.play("sample.mp4")
-        call = await client.voip.video_call(
-            peer, Microphone(), Speaker(), video_source, video_sink
-        )
-        await call.wait_ended()
-        video_source.stop()
+
+async def start_video_call(client, peer, video_sink):
+    video_source = VideoPlayer(fps=15)
+    video_source.play("sample.mp4")
+    call = await client.voip.video_call(
+        peer, Microphone(), Speaker(), video_source, video_sink
+    )
+    await call.wait_ended()
+    video_source.stop()
 ```
 VideoPlayer mendukung 1–60 FPS dengan default 15. FFmpeg harus tersedia di PATH. File yang tidak ditemukan atau FFmpeg yang tidak tersedia akan menghasilkan error yang jelas.
 

{tryx-1.0.3 → tryx-1.3.2}/README.md

@@ -73,7 +73,9 @@ async def on_pairing_qr(_client: TryxClient, event: EvPairingQrCode) -> None:
 async def on_message(client: TryxClient, event: EvMessage) -> None:
     text = (event.data.get_text() or "").strip()
     if text.lower() == "ping":
-        await client.send_text(event.data.message_info.source.chat, "pong", quoted=event)
+        await client.send_text(
+            event.data.message_info.source.chat, "pong", quoted=event
+        )
 
 
 async def main() -> None:
@@ -147,11 +149,15 @@ AudioSource.frames() must yield exactly 1,920 bytes per frame. AudioSink.write()
 ```python
 from collections.abc import AsyncIterator
 from tryx.media import AudioSink, AudioSource, validate_audio_frame
+
+
 class Microphone(AudioSource):
     async def frames(self) -> AsyncIterator[bytes]:
         while True:
             frame = await read_microphone_frame()
             yield validate_audio_frame(frame)
+
+
 class Speaker(AudioSink):
     async def write(self, frame: bytes) -> None:
         validate_audio_frame(frame)
@@ -164,6 +170,8 @@ Replace the two backend functions with PyAudio, sounddevice, ALSA, CoreAudio, or
 
 ```python
 from tryx.types import JID
+
+
 async def start_audio_call(client, phone_number: str):
     peer = JID(phone_number + "@s.whatsapp.net")
     call = await client.voip.call(peer, Microphone(), Speaker())
@@ -177,6 +185,8 @@ Use await call.hangup() to end a call explicitly. Keep the CallHandle alive and
 #### Video Call
 ```python
 from tryx.media import VideoPlayer
+
+
 async def start_video_call(client, peer, video_sink):
     video_source = VideoPlayer(fps=15)
     video_source.play("sample.mp4")
@@ -226,6 +236,7 @@ Use the incoming-call event exported by the installed package version.
 AudioPlayer decodes files in Rust and normalizes them to mono PCM16 at 16 kHz.
 ```python
 from tryx.media import AudioPlayer
+
 player = AudioPlayer(buffer_frames=3)
 player.play("intro.mp3", mode="replace")
 call = await client.voip.call(peer, player, Speaker())
@@ -352,7 +363,9 @@ async def on_pairing_qr(_client: TryxClient, event: EvPairingQrCode) -> None:
 async def on_message(client: TryxClient, event: EvMessage) -> None:
     text = (event.data.get_text() or "").strip()
     if text.lower() == "ping":
-        await client.send_text(event.data.message_info.source.chat, "pong", quoted=event)
+        await client.send_text(
+            event.data.message_info.source.chat, "pong", quoted=event
+        )
 
 
 async def main() -> None:
@@ -427,11 +440,15 @@ AudioSource.frames() 必须每次产生恰好 1,920 字节。AudioSink.write()
 ```python
 from collections.abc import AsyncIterator
 from tryx.media import AudioSink, AudioSource, validate_audio_frame
+
+
 class Microphone(AudioSource):
     async def frames(self) -> AsyncIterator[bytes]:
         while True:
             frame = await read_microphone_frame()
             yield validate_audio_frame(frame)
+
+
 class Speaker(AudioSink):
     async def write(self, frame: bytes) -> None:
         validate_audio_frame(frame)
@@ -443,6 +460,8 @@ class Speaker(AudioSink):
 
 ```python
 from tryx.types import JID
+
+
 async def start_audio_call(client, phone_number: str):
     peer = JID(phone_number + "@s.whatsapp.net")
     call = await client.voip.call(peer, Microphone(), Speaker())
@@ -456,6 +475,8 @@ async def start_audio_call(client, phone_number: str):
 #### 视频通话
 ```python
 from tryx.media import VideoPlayer
+
+
 async def start_video_call(client, peer, video_sink):
     video_source = VideoPlayer(fps=15)
     video_source.play("sample.mp4")
@@ -505,6 +526,7 @@ async def on_incoming_call(_client, event):
 AudioPlayer 在 Rust 中解码文件，并将其标准化为 16 kHz 单声道 PCM16。
 ```python
 from tryx.media import AudioPlayer
+
 player = AudioPlayer(buffer_frames=3)
 player.play("intro.mp3", mode="replace")
 call = await client.voip.call(peer, player, Speaker())
@@ -617,7 +639,9 @@ async def on_pairing_qr(_client: TryxClient, event: EvPairingQrCode) -> None:
 async def on_message(client: TryxClient, event: EvMessage) -> None:
     text = (event.data.get_text() or "").strip()
     if text.lower() == "ping":
-        await client.send_text(event.data.message_info.source.chat, "pong", quoted=event)
+        await client.send_text(
+            event.data.message_info.source.chat, "pong", quoted=event
+        )
 
 
 async def main() -> None:
@@ -688,48 +712,52 @@ AudioSource.frames() harus menghasilkan async iterator dengan tepat 1.920 byte u
 
 #### Adapter Audio Minimal
 ```python
-    from collections.abc import AsyncIterator
-    from tryx.media import AudioSink, AudioSource, validate_audio_frame
+from collections.abc import AsyncIterator
+from tryx.media import AudioSink, AudioSource, validate_audio_frame
+
 
-    class Microphone(AudioSource):
-        async def frames(self) -> AsyncIterator[bytes]:
-            while True:
-                frame = await read_microphone_frame()
-                yield validate_audio_frame(frame)
+class Microphone(AudioSource):
+    async def frames(self) -> AsyncIterator[bytes]:
+        while True:
+            frame = await read_microphone_frame()
+            yield validate_audio_frame(frame)
 
-    class Speaker(AudioSink):
-        async def write(self, frame: bytes) -> None:
-            validate_audio_frame(frame)
-            await play_speaker_frame(frame)
+
+class Speaker(AudioSink):
+    async def write(self, frame: bytes) -> None:
+        validate_audio_frame(frame)
+        await play_speaker_frame(frame)
 ```
 Ganti fungsi perangkat tersebut dengan implementasi PyAudio, sounddevice, ALSA, CoreAudio, atau library perangkat lain.
 
 #### Panggilan Audio 1:1
 ```python
-    from tryx.types import JID
-
-    async def start_audio_call(client, phone_number: str):
-        peer = JID(phone_number + "@s.whatsapp.net")
-        call = await client.voip.call(peer, Microphone(), Speaker())
-        print("call started:", call.call_id)
-        call.set_muted(True)
-        call.set_muted(False)
-        await call.wait_ended()
+from tryx.types import JID
+
+
+async def start_audio_call(client, phone_number: str):
+    peer = JID(phone_number + "@s.whatsapp.net")
+    call = await client.voip.call(peer, Microphone(), Speaker())
+    print("call started:", call.call_id)
+    call.set_muted(True)
+    call.set_muted(False)
+    await call.wait_ended()
 ```
 Gunakan await call.hangup() untuk mengakhiri call secara eksplisit. Pertahankan CallHandle selama call aktif dan tunggu wait_ended() agar cleanup media berjalan deterministik.
 
 #### Panggilan Video
 ```python
-    from tryx.media import VideoPlayer
+from tryx.media import VideoPlayer
 
-    async def start_video_call(client, peer, video_sink):
-        video_source = VideoPlayer(fps=15)
-        video_source.play("sample.mp4")
-        call = await client.voip.video_call(
-            peer, Microphone(), Speaker(), video_source, video_sink
-        )
-        await call.wait_ended()
-        video_source.stop()
+
+async def start_video_call(client, peer, video_sink):
+    video_source = VideoPlayer(fps=15)
+    video_source.play("sample.mp4")
+    call = await client.voip.video_call(
+        peer, Microphone(), Speaker(), video_source, video_sink
+    )
+    await call.wait_ended()
+    video_source.stop()
 ```
 VideoPlayer mendukung 1–60 FPS dengan default 15. FFmpeg harus tersedia di PATH. File yang tidak ditemukan atau FFmpeg yang tidak tersedia akan menghasilkan error yang jelas.
 

{tryx-1.0.3 → tryx-1.3.2}/docs/api/backend.md

@@ -46,9 +46,10 @@ exposing `lib_path` and `connect_string` attributes satisfies this protocol.
 
 ```python
 class PostgresStore:
-    lib_path: str   # path to compiled .so
+    lib_path: str  # path to compiled .so
     connect_string: str
 
+
 backend = PostgresStore(
     lib_path="./libtryx_pg.so",
     connect_string="host=localhost dbname=tryx",
@@ -63,15 +64,13 @@ abstract methods for full control over storage operations.
 ```python
 from tryx.backend import StoreBase
 
+
 class RedisStore(StoreBase):
-    async def get(self, key: str) -> bytes | None:
-        ...
+    async def get(self, key: str) -> bytes | None: ...
 
-    async def set(self, key: str, value: bytes) -> None:
-        ...
+    async def set(self, key: str, value: bytes) -> None: ...
 
-    async def delete(self, key: str) -> None:
-        ...
+    async def delete(self, key: str) -> None: ...
 ```
 
 ## When to Choose Each Backend