expose IdomWebsocket via django_idom

Author: Archmonger

README.md

@@ -36,11 +36,13 @@ feel free to organize your component modules you wish. Any components created wi
 by Python dotted path in `your-template.html`.
 
 ```python
-import idom
+from idom import component, html
+from django_idom import IdomWebsocket
 
-@idom.component
-def Hello(websocket, greeting_recipient):  # Names are CamelCase by ReactJS convention
-    return idom.html.header(f"Hello {greeting_recipient}!")
+
+@component
+def Hello(websocket: IdomWebsocket, greeting_recipient):  # Names are CamelCase by ReactJS convention
+    return html.header(f"Hello {greeting_recipient}!")
 ```
 
 ## `example_app/templates/your-template.html`

src/django_idom/__init__.py

@@ -1,4 +1,6 @@
+from .websocket.consumer import IdomWebsocket
 from .websocket.paths import IDOM_WEBSOCKET_PATH
 
+
 __version__ = "0.0.1"
-__all__ = ["IDOM_WEBSOCKET_PATH"]
+__all__ = ["IDOM_WEBSOCKET_PATH", "IdomWebsocket"]

src/django_idom/websocket/consumer.py

@@ -19,7 +19,7 @@
 
 
 @dataclass
-class WebsocketConnection:
+class IdomWebsocket:
     scope: dict
     close: Callable[[Optional[int]], Awaitable[None]]
     disconnect: Callable[[int], Awaitable[None]]
@@ -67,7 +67,7 @@ async def _run_dispatch_loop(self):
         component_kwargs = json.loads(query_dict.get("kwargs", "{}"))
 
         # Provide developer access to parts of this websocket
-        socket = WebsocketConnection(self.scope, self.close, self.disconnect, view_id)
+        socket = IdomWebsocket(self.scope, self.close, self.disconnect, view_id)
 
         try:
             component_instance = component_constructor(socket, **component_kwargs)