Add asyncio & threading examples to the homepage.

Fix #1437.

Author: aaugustin

docs/index.rst

@@ -60,13 +60,24 @@ list of features provided by each implementation.
    implementation, and then some. If you're using the historical implementation,
    you should :doc:`ugrade to the new implementation <howto/upgrade>`.
 
-Here's an echo server using the :mod:`asyncio` API:
+Here's an echo server and corresponding client.
 
-.. literalinclude:: ../example/echo.py
+.. tab:: asyncio
 
-Here's a client using the :mod:`threading` API:
+    .. literalinclude:: ../example/asyncio/echo.py
 
-.. literalinclude:: ../example/hello.py
+.. tab:: threading
+
+    .. literalinclude:: ../example/sync/echo.py
+
+.. tab:: asyncio
+    :new-set:
+
+    .. literalinclude:: ../example/asyncio/hello.py
+
+.. tab:: threading
+
+    .. literalinclude:: ../example/sync/hello.py
 
 Don't worry about the opening and closing handshakes, pings and pongs, or any
 other behavior described in the WebSocket specification. websockets takes care

example/echo.py renamed to example/asyncio/echo.py

@@ -1,14 +1,20 @@
 #!/usr/bin/env python
 
+"""Echo server using the asyncio API."""
+
 import asyncio
 from websockets.asyncio.server import serve
 
+
 async def echo(websocket):
     async for message in websocket:
         await websocket.send(message)
 
+
 async def main():
-    async with serve(echo, "localhost", 8765):
-        await asyncio.get_running_loop().create_future()  # run forever
+    async with serve(echo, "localhost", 8765) as server:
+        await server.serve_forever()
+
 
-asyncio.run(main())
+if __name__ == "__main__":
+    asyncio.run(main())

example/asyncio/hello.py

@@ -0,0 +1,17 @@
+#!/usr/bin/env python
+
+"""Client using the asyncio API."""
+
+import asyncio
+from websockets.asyncio.client import connect
+
+
+async def hello():
+    async with connect("ws://localhost:8765") as websocket:
+        await websocket.send("Hello world!")
+        message = await websocket.recv()
+        print(message)
+
+
+if __name__ == "__main__":
+    asyncio.run(hello())

example/ruff.toml

@@ -0,0 +1,2 @@
+[lint.isort]
+no-sections = true

example/sync/echo.py

@@ -0,0 +1,19 @@
+#!/usr/bin/env python
+
+"""Echo server using the threading API."""
+
+from websockets.sync.server import serve
+
+
+def echo(websocket):
+    for message in websocket:
+        websocket.send(message)
+
+
+def main():
+    with serve(echo, "localhost", 8765) as server:
+        server.serve_forever()
+
+
+if __name__ == "__main__":
+    main()

example/hello.py renamed to example/sync/hello.py

@@ -1,12 +1,16 @@
 #!/usr/bin/env python
 
-import asyncio
+"""Client using the threading API."""
+
 from websockets.sync.client import connect
 
+
 def hello():
     with connect("ws://localhost:8765") as websocket:
         websocket.send("Hello world!")
         message = websocket.recv()
-        print(f"Received: {message}")
+        print(message)
+
 
-hello()
+if __name__ == "__main__":
+    hello()