Skip to content
This repository was archived by the owner on Dec 10, 2018. It is now read-only.

Commit a3349b8

Browse files
committed
readme and docs updates
1 parent 591dc28 commit a3349b8

File tree

2 files changed

+21
-11
lines changed

2 files changed

+21
-11
lines changed

README.rst

+10-2
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,15 @@ python lib):
9797
official implemention servers and clients, such as a upstream server with
9898
a thriftpy client or the opposite.
9999

100-
(Currently only binary protocol & buffered transport were implemented.)
100+
Currently implemented protocols and transports:
101+
102+
* binary protocol (python and cython implemention)
103+
104+
* buffered transport
105+
106+
* tornado server and client (with tornado 4.0)
107+
108+
* framed transport
101109

102110
- Can directly load thrift file as module, the sdk code will be generated on
103111
the fly.
@@ -109,7 +117,7 @@ python lib):
109117
import the 'pingpong.thrift' file as module.
110118

111119
- Pure python, standalone implemention. No longer need to compile & install
112-
the 'thrift' package. All you need is python and thrift file.
120+
the 'thrift' package. All you need is thrift file.
113121

114122
- Easy RPC server/client setup.
115123

docs/index.rst

+11-9
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ usage examples.
6969
Features
7070
========
7171

72+
7273
Currently ThriftPy have these features (also advantages over the upstream
7374
python lib):
7475

@@ -78,7 +79,15 @@ python lib):
7879
official implemention servers and clients, such as a upstream server with
7980
a thriftpy client or the opposite.
8081

81-
(Currently only binary protocol & buffered transport were implemented.)
82+
Currently implemented protocols and transports:
83+
84+
* binary protocol (python and cython implemention)
85+
86+
* buffered transport
87+
88+
* tornado server and client (with tornado 4.0)
89+
90+
* framed transport
8291

8392
- Can directly load thrift file as module, the sdk code will be generated on
8493
the fly.
@@ -90,7 +99,7 @@ python lib):
9099
import the 'pingpong.thrift' file as module.
91100

92101
- Pure python, standalone implemention. No longer need to compile & install
93-
the 'thrift' package. All you need is python and thrift file.
102+
the 'thrift' package. All you need is thrift file.
94103

95104
- Easy RPC server/client setup.
96105

@@ -115,15 +124,8 @@ You may also install cython first to build cython extension locally.
115124
Use Cython Binary Protocol
116125
==========================
117126

118-
.. note::
119-
120-
The cython binary protocol is still very experimental and the code need to
121-
be audited. Use with caution.
122-
123127
The TCyBinaryProtocol can be used to accelerate serialize and deserialize.
124128

125-
Pass TCyBinaryProtocolFactory to make_server to enable it.
126-
127129
.. code:: python
128130
129131
from thriftpy.protocol import TCyBinaryProtocolFactory

0 commit comments

Comments
 (0)