From 3cda647883b1f804e9d5bcf55e4d5c1e2b15d328 Mon Sep 17 00:00:00 2001
From: meejah <meejah@meejah.ca>
Date: Thu, 15 Apr 2021 12:09:44 -0600
Subject: [PATCH] document test-clients

---
 client.py    |  7 ++++++-
 ws_client.py | 10 +++++++++-
 2 files changed, 15 insertions(+), 2 deletions(-)

diff --git a/client.py b/client.py
index 8998a64..5c7d235 100644
--- a/client.py
+++ b/client.py
@@ -1,4 +1,9 @@
-from __future__ import print_function
+"""
+This is a test-client for the transit-relay that uses TCP. It
+doesn't send any data, only prints out data that is received. Uses a
+fixed token of 64 'a' characters. Always connects on localhost:4001
+"""
+
 
 from twisted.internet import endpoints
 from twisted.internet.defer import (
diff --git a/ws_client.py b/ws_client.py
index 93dacfc..27e989c 100644
--- a/ws_client.py
+++ b/ws_client.py
@@ -1,4 +1,12 @@
-from __future__ import print_function
+"""
+This is a test-client for the transit-relay that uses WebSockets.
+
+If an additional command-line argument (anything) is added, it will
+send 5 messages upon connection. Otherwise, it just prints out what is
+received. Uses a fixed token of 64 'a' characters. Always connects on
+localhost:4002
+"""
+
 import sys
 
 from twisted.internet import endpoints