chore: use vcdiff lib from central pypi

Author: ttypic

ably/__init__.py

@@ -8,7 +8,7 @@
 from ably.types.options import Options, VCDiffDecoder
 from ably.util.crypto import CipherParams
 from ably.util.exceptions import AblyException, AblyAuthException, IncompatibleClientIdException
-from ably.vcdiff_plugin import VCDiffPlugin
+from ably.vcdiff.ably_vcdiff_decoder import AblyVCDiffDecoder
 
 import logging
 

ably/types/options.py

@@ -22,7 +22,7 @@ def __init__(self, client_id=None, log_level=0, tls=True, rest_host=None, realti
                  fallback_retry_timeout=None, disconnected_retry_timeout=None, idempotent_rest_publishing=None,
                  loop=None, auto_connect=True, suspended_retry_timeout=None, connectivity_check_url=None,
                  channel_retry_timeout=Defaults.channel_retry_timeout, add_request_ids=False,
-                 vcdiff_decoder=None, **kwargs):
+                 vcdiff_decoder: VCDiffDecoder = None, **kwargs):
 
         super().__init__(**kwargs)
 

ably/vcdiff/__init__.py

@@ -1,20 +1,20 @@
 """
-VCDiff Plugin for Ably Python SDK
+VCDiff Decoder for Ably Python SDK
 
-This module provides a production-ready VCDiff decoder plugin using the vcdiff library.
+This module provides a production-ready VCDiff decoder using the vcdiff-decoder library.
 It implements the VCDiffDecoder interface.
 
 Usage:
-    from ably import VCDiffPlugin, AblyRealtime
+    from ably.vcdiff import AblyVCDiffDecoder, AblyRealtime
 
-    # Create VCDiff plugin
-    plugin = VCDiffPlugin()
+    # Create VCDiff decoder
+    vcdiff_decoder = AblyVCDiffDecoder()
 
-    # Create client with plugin
-    client = AblyRealtime(key="your-key", vcdiff_decoder=plugin)
+    # Create client with decoder
+    client = AblyRealtime(key="your-key", vcdiff_decoder=vcdiff_decoder)
 
     # Get channel with delta enabled
-    channel = client.channels.get("test", {"delta": "vcdiff"})
+    channel = client.channels.get("test", ChannelOptions(params={"delta": "vcdiff"}))
 """
 
 import logging
@@ -25,9 +25,9 @@
 log = logging.getLogger(__name__)
 
 
-class VCDiffPlugin(VCDiffDecoder):
+class AblyVCDiffDecoder(VCDiffDecoder):
     """
-    Production VCDiff decoder plugin using Ably's vcdiff library.
+    Production VCDiff decoder using Ably's vcdiff-decoder library.
 
     Raises:
         ImportError: If vcdiff is not installed
@@ -38,10 +38,10 @@ def __init__(self):
         """Initialize the VCDiff plugin.
 
         Raises:
-            ImportError: If vcdiff library is not available
+            ImportError: If vcdiff-decoder library is not available
         """
         try:
-            import vcdiff
+            import vcdiff_decoder as vcdiff
             self._vcdiff = vcdiff
         except ImportError as e:
             log.error("vcdiff library not found. Install with: pip install ably[vcdiff]")
@@ -79,4 +79,4 @@ def decode(self, delta: bytes, base: bytes) -> bytes:
 
 
 # Export for easy importing
-__all__ = ['VCDiffPlugin']
+__all__ = ['AblyVCDiffDecoder']

ably/vcdiff_plugin.py renamed to ably/vcdiff/ably_vcdiff_decoder.py

@@ -56,12 +56,12 @@ pyee = [
 # Optional dependencies
 pycrypto = { version = "^2.6.1", optional = true }
 pycryptodome = { version = "*", optional = true }
-vcdiff = { version = "^0.1.0a2", source = "experimental", optional = true }
+vcdiff-decoder = { version = "^0.1.0a1", optional = true }
 
 [tool.poetry.extras]
 oldcrypto = ["pycrypto"]
 crypto = ["pycryptodome"]
-vcdiff = ["vcdiff"]
+vcdiff = ["vcdiff-decoder"]
 
 [tool.poetry.dev-dependencies]
 pytest = "^7.1"
@@ -82,7 +82,7 @@ pytest-rerunfailures = [
 ]
 async-case = { version = "^10.1.0", python = "~3.7" }
 tokenize_rt = "*"
-vcdiff = { version = "^0.1.0a2", source = "experimental" }
+vcdiff-decoder = { version = "^0.1.0a1" }
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

poetry.lock

@@ -1,7 +1,7 @@
 import asyncio
 import json
 
-from ably import VCDiffPlugin
+from ably import AblyVCDiffDecoder
 from ably.realtime.realtime_channel import ChannelOptions
 from test.ably.testapp import TestApp
 from test.ably.utils import BaseAsyncTestCase, WaitableEvent
@@ -15,11 +15,11 @@ class MockVCDiffDecoder(VCDiffDecoder):
     def __init__(self):
         self.number_of_calls = 0
         self.last_decoded_data = None
-        self.plugin = VCDiffPlugin()
+        self.vcdiff_decoder = AblyVCDiffDecoder()
 
     def decode(self, delta: bytes, base: bytes) -> bytes:
         self.number_of_calls += 1
-        self.last_decoded_data = self.plugin.decode(delta, base)
+        self.last_decoded_data = self.vcdiff_decoder.decode(delta, base)
         return self.last_decoded_data