PyAgoraRTC 0.2.0__tar.gz → 0.2.2__tar.gz

{pyagorartc-0.2.0 → pyagorartc-0.2.2}/.github/workflows/release.yml

@@ -66,7 +66,9 @@ jobs:
       - name: Create GitHub Release
         uses: softprops/action-gh-release@v2
         with:
-          files: dist/*
+          files: 
+            dist/*.whl
+            dist/*.tar.gz
           generate_release_notes: true
           prerelease: ${{ steps.version.outputs.prerelease }}
         env:

{pyagorartc-0.2.0 → pyagorartc-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: PyAgoraRTC
-Version: 0.2.0
+Version: 0.2.2
 Summary: Async Python client for Agora RTC signalling: edge discovery, SDP/ORTC negotiation and the WebSocket gateway session
 Project-URL: Homepage, https://github.com/mikey0000/PyAgoraRTC
 Project-URL: Documentation, https://github.com/mikey0000/PyAgoraRTC/tree/main/docs

{pyagorartc-0.2.0 → pyagorartc-0.2.2}/docs/architecture.md

@@ -77,7 +77,9 @@ host: s = AgoraSession(creds, ap, options, callbacks…)
            (JoinRejectedError / JoinTimeoutError; never a fabricated SDP)
         4. subscribe to streams already in the join payload, and to each
            announced stream once both on_add_video_stream and
-           on_user_online for its publisher have been seen (any order),
+           on_user_online for its publisher have been seen (any order;
+           a held stream logs its uid at DEBUG, Q18) — or on the
+           announcement alone with subscribe_requires_online=False (D28),
            filtered by target_uid and never our own uid; each subscribe
            task calls on_stream(stream) once, after its first subscribe
         5. start owned tasks: ping, keepalive (if given); every timer
@@ -145,6 +147,7 @@ new `AgoraSession`. That is what keeps state simple enough to reason about.
 | `set_client_role` after join | `SessionOptions.send_set_client_role` (default off) | knowing the device tolerates it |
 | Join codec and flags | `client_codec` (default `vp8`, D7), `prealloc_pc` (default on, Q10), `extra_join_attributes` (merged into `userAttributes` last; stored read-only) | the codec its device publishes; any flag it needs |
 | DTLS role in the client ORTC | `ortc_dtls_role` (default `server`; `None` sends none, D4/Q2) | a parity experiment |
+| Subscribing before presence | `subscribe_requires_online` (default on, D28/Q18) | whether its gateway sends `on_user_online` for a publisher |
 | Ending on `on_p2p_lost` | `end_on_p2p_lost` (default off, D22) | whether its device treats it as fatal |
 | Renewal cadence | `renew_debounce_s` (default 30 s, D8/Q11) | nothing, unless the gateway penalises repeats |
 | Timeouts | `join_timeout_s` (15 s), `connect_timeout_s` (10 s) | a slower network |

{pyagorartc-0.2.0 → pyagorartc-0.2.2}/docs/backlog.md

@@ -19,6 +19,15 @@ Open work only; finished items are deleted.
   coverage.
 - A fake gateway knob that omits `dtlsParameters.fingerprints` from the join
   response, so D26's fill-in gets integration coverage (Q19).
+- A way for a host to filter the join's inline candidates. PetKit dropped
+  host candidates before the join (`whep_proxy.py:170-173`); `join()` now
+  sends every `a=candidate:` in the offer. The workaround (strip the lines,
+  `add_ice_candidate` the filtered ones, migration §3.6) works; decide after
+  the PetKit run whether an option is worth it.
+- Send AP detail `6` without putting `string_uid` into the join. PetKit's AP
+  request always carried `6 = str(uid)` (`agora_api.py:320-321`) and its join
+  none (`agora_websocket.py:686`); `ChannelCredentials.string_uid` couples
+  the two (Q9).
 - Post-join trickle candidates once Q4 is answered.
 - ICE restart / rejoin with `rejoin_token` (the field is stored today and
   never used).
@@ -31,12 +40,17 @@ Open work only; finished items are deleted.
 
 ## Hosts
 
-- HA-Luba: replace `custom_components/mammotion/agora_*.py` with `pyagorartc`
-  per `docs/migration.md`; keep its six Agora tests as library tests (done
-  here) and delete the local copies.
-- PetKit: migration per `docs/migration.md`; the `set_client_role` question
-  (Q3) must be answered on real hardware before the default changes for
-  them.
+- HA-Luba: merge the `pyagorartc-migration` branch (`docs/migration.md` §2)
+  once the hardware run below passes.
+- HA-Luba: run one WiFi and one 4G session on a Luba 2 and a Yuka across all
+  camera uids to validate the migration (Q2, Q5, Q6, Q10, Q11; migration §4).
+- pymammotion drops its unused `sdp-transform`, `websockets`, `webrtc-models`
+  requirements.
+- PetKit: migration per `docs/migration.md` §3. One go2rtc session per
+  camera model at DEBUG answers Q18 first (it decides the default of
+  `subscribe_requires_online`, D28), then Q3, Q7 and
+  Q13 (migration §4). `send_set_client_role` and `end_on_p2p_lost` stay on
+  for PetKit until those runs say otherwise.
 
 ## Documentation
 

{pyagorartc-0.2.0 → pyagorartc-0.2.2}/docs/decisions.md

@@ -191,7 +191,7 @@ socket and tasks and fires `on_closed(JOIN_FAILED)` before raising (a socket
 that closes after the join result but before `join()` acts on it is a failed
 join, `GatewayConnectError`, not a silently dead joined session); the
 gateway's quit, a socket close, the deadline and (with D22) `p2p_lost` fire
-their reasons. `close()` is idempotent and safe after a failed join. A
+their reasons, including when they land while `join()` is in flight (D29). `close()` is idempotent and safe after a failed join. A
 candidate added after `join()` is ignored with a DEBUG line (Q4).
 
 ## D24. `parse_offer` restores what `sdp_transform` coerces (amends D3)
@@ -239,3 +239,32 @@ dozen characters, so a `renew_token` frame is logged whole, token included
 `pyagorartc.session.wire`, set to INFO. A host that needs the frames can set
 that logger to DEBUG on purpose; the session's own frame lines go through
 `describe_frame` and carry no values.
+
+## D28. The presence gate on subscribe is an option
+
+HA-Luba subscribed to an announced stream only once its publisher's
+`on_user_online` had been seen; PetKit subscribed on `on_add_video_stream`
+alone, and its camera likely starts publishing after the join, so the gate
+could hold its stream forever. `SessionOptions.subscribe_requires_online`
+defaults to `True`, preserving the Mammotion rule; PetKit passes `False`,
+which counts the announced uid as present so `on_user_offline` still tears
+the subscription down. A held stream logs its uid at DEBUG. Q18 decides the
+eventual default.
+
+## D29. A quit or `p2p_lost` during `join()` fails the join with its own reason (amends D23)
+
+The gateway sends the older session's 2003 quit when a second join on the
+same uid lands, which can be right behind the older session's own join
+result: the reader dispatches both before `join()` resumes. The handlers
+used to act only on a joined session, so the quit was dropped and `join()`
+answered for a session the gateway had already quit (a frozen feed in HA).
+A quit, or `p2p_lost` with `end_on_p2p_lost`, that arrives before `join()`
+has marked the session joined is recorded; `join()` then raises
+`GatewayConnectError` and `on_closed` fires once with `GATEWAY_QUIT` /
+`P2P_LOST`, not `JOIN_FAILED`: the join succeeded at the gateway and the
+reason is what the host acts on. It is checked ahead of the socket-close
+race, since the gateway closes the socket after the quit. One that arrives
+before the result fails the join at once instead of waiting out the
+timeout. `GatewayConnectError`, not `JoinRejectedError`: the join result was
+a success, and `JoinRejectedError` carries a join-result code the gateway
+never sent; this is the same shape as the socket-close race.