As of this writing (in Jan 2013) there are a few jsonrpc libraries already out there on PyPI, most of them handling one specific use case (e.g. json via WSGI, using Twisted, or TCP-sockets).
None of the libraries, however, made it easy to reuse the jsonrpc-parsing bits and substitute a different transport (i.e. going from json via TCP to an implementation using WebSockets or 0mq).
In the end, all these libraries have their own dispatching interfaces and a custom implementation of handling jsonrpc.
tinyrpc aims to do better by dividing the problem into cleanly
interchangeable parts that allow easy addition of new transport methods, RPC
protocols or dispatchers.
You'll quickly find that tinyrpc has more documentation and tests than core
code, hence the name. See the documentation at
<https://tinyrpc.readthedocs.org> for more details, especially the
Structure-section to get a birds-eye view.
pip install tinyrpcwill install tinyrpc with its default dependencies.
Depending on the protocols and transports you want to use additional dependencies are required. You can instruct pip to install these dependencies by specifying extras to the basic install command.
pip install tinyrpc[httpclient, wsgi]will install tinyrpc with dependencies for the httpclient and wsgi transports.
Available extras are:
| Option | Needed to use objects of class |
|---|---|
| gevent | optional in RPCClient, required by RPCServerGreenlets |
| httpclient | HttpPostClientTransport, HttpWebSocketClientTransport |
| jsonext | optional in JSONRPCProtocol |
| websocket | WSServerTransport |
| wsgi | WsgiServerTransport |
| zmq | ZmqServerTransport, ZmqClientTransport |