Skip to content
forked from riga/jsonrpyc

Minimal python JSON-RPC 2.0 implementation in a single file.

License

Notifications You must be signed in to change notification settings

fluidbox/jsonrpyc

 
 

Repository files navigation

jsonrpyc logo

Build Status Documentation Status Package Status License

Minimal python RPC implementation in a single file based on the JSON-RPC 2.0 specs.

Usage

jsonrpyc.RPC instances basically wrap an input stream and an output stream in order to communicate with other services. A service is not even forced to be written in Python as long as it strictly implements the JSON-RPC 2.0 specs. A suitable implementation for NodeJs is node-json-rpc. A jsonrpyc.RPC instance may wrap a target object. Incomming requests will be routed to methods of this object whose result might be sent back as a response. Example implementation:

server.py
import jsonrpyc

class MyTarget(object):

    def greet(self, name):
        return "Hi, %s!" % name

jsonrpyc.RPC(MyTarget())
client.py
import jsonrpyc
from subprocess import Popen, PIPE

p = Popen(["python", "server.py"], stdin=PIPE, stdout=PIPE)
rpc = jsonrpyc.RPC(stdout=p.stdin, stdin=p.stdout)


#
# sync usage
#

print(rpc("greet", args=("John",), block=0.1))
# => "Hi, John!"


#
# async usage
#

def cb(err, res=None):
    if err:
        raise err
    print("callback got: " + res)

rpc("greet", args=("John",), callback=cb)

# cb is called asynchronously which prints
# => "callback got: Hi, John!"


#
# shutdown
#

p.stdin.close()
p.stdout.close()
p.terminate()
p.wait()

Installation

Via pip

pip install jsonrpyc

or by simply copying the file into your project.

Contributing

If you like to contribute to jsonrpyc, I'm happy to receive pull requests. Just make sure to add new test cases and run them via:

> python -m unittest tests

Development

About

Minimal python JSON-RPC 2.0 implementation in a single file.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%