Skip to main content

A JSON-RPC client library, backed by requests

Project description

https://travis-ci.org/gciotta/jsonrpc-requests.svg https://coveralls.io/repos/gciotta/jsonrpc-requests/badge.svg

This is a compact and simple JSON-RPC client implementation written while debugging a picky server.

Main Features

  • Python 2.7, 3.4, 3.5, 3.6 compatible

  • Exposes requests options

  • Supports nested namespaces (eg. app.users.getUsers())

  • 100% test coverage

TODO

Usage

from jsonrpc_requests import Server
server = Server('http://localhost:8080')
server.foo(1, 2)
server.foo(bar=1, baz=2)
server.foo({'foo': 'bar'})
server.foo.bar(baz=1, qux=2)

A notification:

from jsonrpc_requests import Server
server.foo(bar=1, _notification=True)

Pass through arguments to requests (see also requests documentation)

from jsonrpc_requests import Server
server = Server('http://localhost:8080', auth=('user', 'pass'), headers={'x-test2': 'true'})

Pass through requests exceptions

from jsonrpc_requests import Server, TransportError
server = Server('http://unknown-host')
try:
    server.foo()
except TransportError as transport_error:
    print(transport_error.cause) # this will hold a `requests.exceptions.RequestException` instance

Tests

Install the Python tox package and run tox, it’ll test this package with various versions of Python.

Credits

@mbroadst for providing full support for nested method calls, JSON-RPC RFC compliance and other improvements.

@vaab for providing api and tests improvements, better RFC compliance.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jsonrpc-requests-0.4.0.zip (8.9 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page