summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHiroki Ohtani <liris.pp@gmail.com>2018-05-27 14:09:36 +0900
committerHiroki Ohtani <liris.pp@gmail.com>2018-05-27 14:09:36 +0900
commitdf275d351f9887fba2774e2e1aa79ff1e5a24bd1 (patch)
tree8b5ec16b37643061d985caa21ef21123e60cbfd1
parent65d99ba2bd468af22253a0c7524971cbab260e84 (diff)
downloadwebsocket-client-df275d351f9887fba2774e2e1aa79ff1e5a24bd1.tar.gz
fix formatv0.48.0
-rw-r--r--README.rst12
1 files changed, 10 insertions, 2 deletions
diff --git a/README.rst b/README.rst
index 7c30398..86e3235 100644
--- a/README.rst
+++ b/README.rst
@@ -31,7 +31,7 @@ This module depend on
performance
------------------
- "send" method is too slow on pure python. If you want to get better performace, please install numpy or wsaccel.
+"send" method is too slow on pure python. If you want to get better performace, please install numpy or wsaccel.
You can get the best performance from numpy.
@@ -60,7 +60,6 @@ example
-
Examples
========
@@ -123,6 +122,7 @@ This is if you want to communicate a short message and disconnect immediately wh
print("Received '%s'" % result)
ws.close()
+
If you want to customize socket options, set sockopt.
sockopt example
@@ -167,6 +167,7 @@ WebSocketApp sample
ws = websocket.WebSocketApp("wss://echo.websocket.org")
ws.run_forever(sslopt={"cert_reqs": ssl.CERT_NONE})
+
create_connection sample
.. code:: python
@@ -174,6 +175,7 @@ create_connection sample
ws = websocket.create_connection("wss://echo.websocket.org",
sslopt={"cert_reqs": ssl.CERT_NONE})
+
WebSocket sample
.. code:: python
@@ -195,6 +197,7 @@ WebSocketApp sample
ws = websocket.WebSocketApp("wss://echo.websocket.org")
ws.run_forever(sslopt={"check_hostname": False})
+
create_connection sample
.. code:: python
@@ -202,6 +205,7 @@ create_connection sample
ws = websocket.create_connection("wss://echo.websocket.org",
sslopt={"check_hostname": False})
+
WebSocket sample
.. code:: python
@@ -244,6 +248,7 @@ sample for echo.websocket.org::
> How are you?
< How are you?
+
Usage
---------
@@ -251,16 +256,19 @@ usage::
wsdump.py [-h] [-v [VERBOSE]] ws_url
+
WebSocket Simple Dump Tool
positional arguments:
ws_url websocket url. ex. ws://echo.websocket.org/
+
optional arguments:
-h, --help show this help message and exit
WebSocketApp
-v VERBOSE, --verbose VERBOSE set verbose mode. If set to 1, show opcode. If set to 2, enable to trace websocket module
+
example::
$ wsdump.py ws://echo.websocket.org/