A small, modular, transport and protocol neutral RPC library that, among other things, supports JSON-RPC and zmq.


Keywords
json, rpc, json-rpc, jsonrpc, 0mq, zmq, zeromq
License
MIT
Install
pip install tinyrpc==1.1.7

Documentation

tinyrpc: A small and modular way of handling web-related RPC

image

image

image

Note

Tinyrpc has been revised.

The current version will support Python3 only. Have a look at the 0.9.x version if you need Python2 support. Python2 support will be dropped completely when Python2 retires, somewhere in 2020.

Motivation

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, makes 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. Today (march 2019) that hasn't changed.

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.

Example:

To create a server process receiving and handling JSONRPC requests do:

The corresponding client code looks like:

Documentation

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.

Installation

will install tinyrpc with its default dependencies.

Optional 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.

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
msgpack implements MSGPACKRPCProtocol
jsonext optional in JSONRPCProtocol
rabbitmq RabbitMQServerTransport, RabbitMQClientTransport
websocket WSServerTransport
wsgi WsgiServerTransport
zmq ZmqServerTransport, ZmqClientTransport

New in version 1.1.0

Tinyrpc supports RabbitMQ has transport medium.

New in version 1.0.4

Tinyrpc now supports the MSGPACK RPC protocol in addition to JSON-RPC.