Commits

Anonymous committed af85b71

Update and rename README

  • Participants
  • Parent commits 745839c

Comments (0)

Files changed (2)

File README

-This is a client for the Websocket protocol (IETF RFC6455) for the Twisted framework.
-
-See http://tools.ietf.org/html/rfc6455 for the specifications of the protocol.
-
-
-Testing
-*******
-
-This server has been tested against the Autobahn test suite.
-
-0) Get and install Autobahn (http://www.tavendo.de/autobahn/testsuite.html)
-
-1) Start the Autobahn test suite server
-   (``fuzzing_server.py`` is located in the source of Autobahn, in the ``testsuite/websockets`` directory)::
-
-        python fuzzing_server.py
-
-2) Run:
-
-    - a specific test case (1)::
-
-        python ./autobahn_test_client.py -c1
-
-    - a bunch of tests (16) starting at (1)::
-    
-        python ./autobahn_test_client.py -c1 -n 16
-
-    - complete test suite::
-    
-        python ./autobahn_test_client.py -a
-
-    - update the report::
-    
-        python ./autobahn_test_client.py -u
-
-    - a quick help::
-    
-        python ./autobahn_test_client.py -h
-
-3) Check the report at http://localhost:9090/reports/clients/index.html
-
-
-Usage
-*****
-
-**TODO**: Refer to the ``autobahn_test_client.py`` for a sample usage.
-
-
-
-Many thanks
-***********
-
-- to Rlotun for the txWebsocket server (http://github.com/rlotun/txWebSocket)
-
-- to Tobias Oberstein (Tavendo GmbH) for the Autobahn test suite
-
-- to the many people contributing to the Twisted framework
-
-- to the many people contributing to the Python language
-
-- to the many people who have contributed to the definition of the Websocket protocol
-
-- anyone who will contribute to the improvement of this software :)
-
-
-
-TODO
-****
-
-    - Additional testing for the UTF-8 decoding
-
-    - TLS (wss) tests
-
-    - Extensions
-
-
-
-License
-*******
-
-This software is released under the same terms than the Twisted license.
-See the LICENSE file distributed with this software.
+This is a client for the Websocket protocol (IETF RFC6455) for the Twisted framework.
+
+See http://tools.ietf.org/html/rfc6455 for the specifications of the protocol.
+
+
+Testing
+*******
+
+Trial (Twisted unit testing suite)
+----------------------------------
+
+The trial tests require a version of txwebsocket that can be found at: https://github.com/aprilmay/txWebSocket.
+
+Run them with: trial test_websocket_client
+
+
+Autobahn
+--------
+
+The Autobahn test suite is used as third party reference point.
+These tests are also more functional than the Trial based ones.
+
+0) Get and install Autobahn (http://www.tavendo.de/autobahn/testsuite.html)
+
+1) Start the Autobahn test suite server
+   (``fuzzing_server.py`` is located in the source of Autobahn, in the ``testsuite/websockets`` directory)::
+
+        python fuzzing_server.py
+
+2) Run:
+
+    - a specific test case (1)::
+
+        python ./autobahn_test_client.py -c1
+
+    - a bunch of tests (16) starting at (1)::
+    
+        python ./autobahn_test_client.py -c1 -n 16
+
+    - complete test suite::
+    
+        python ./autobahn_test_client.py -a
+
+    - update the report::
+    
+        python ./autobahn_test_client.py -u
+
+    - a quick help::
+    
+        python ./autobahn_test_client.py -h
+
+3) Check the report at http://localhost:9090/reports/clients/index.html
+
+NOTE: Currently the tests that should handle UTF-8 decoding errors are failing.
+
+
+Usage
+*****
+
+**TODO**: Refer to the ``autobahn_test_client.py`` for a sample usage.
+
+
+
+Many thanks
+***********
+
+- to Rlotun and the other contributors for the txWebsocket server (http://github.com/rlotun/txWebSocket)
+
+- to Tobias Oberstein (Tavendo GmbH) for the Autobahn test suite
+
+- to the many people contributing to the Twisted framework
+
+- to the many people contributing to the Python language
+
+- to the many people who have contributed to the definition of the Websocket protocol
+
+- anyone who will contribute to the improvement of this software :)
+
+
+
+TODO
+****
+
+    - Additional testing for the UTF-8 decoding
+
+    - TLS (wss) tests
+
+    - Extensions/subprotocols
+
+
+
+License
+*******
+
+This software is released under the same terms than the Twisted license.
+See the LICENSE file distributed with this software.