Skip to main content
Help us improve Python packaging – donate today!

Bidirectionnal RPC Api on top of pyzmq

Project Description

https://travis-ci.org/ezeep/pseud.svg?branch=master https://coveralls.io/repos/ezeep/pseud/badge.png Latest Version Code Health

Pythonic bidirectional-rpc API built on top of ØMQ with pluggable encryption, authentication and heartbeating support.

Features

  1. ØMQ transport layer.
  2. All native python types supported (msgpack).
  3. First citizen exceptions.
  4. Bi-bidirectional (server can initiate calls to connected clients).
  5. Encryption based on CURVE.
  6. Pluggable Authentication.
  7. Pluggable Heartbeating.
  8. Pluggable Remote Call Routing.
  9. Works with tornado ioloop or gevent.
  10. Built-in proxy support. A server can delegate the work to another one.
  11. SyncClient (using zmq.REQ) to use within non event based processes. (Heartbeating, Authentication and job execution are not supported with the SyncClient.)

Installation

Dependencies are declared in setup.py and all automatically installed, but, pyzmq might build libzmq from bundled folder OR from your system wide libzmq. In later case you should make sure libzmq has been compiled with libsodium to take advantage of curve security features.

We recommend to install pyzmq with bundled libzmq explicitely if libzmq is already installed on your system.

$ pip install pyzmq --install-option='--zmq=bundled'

Tornado

$ pip install -e .[Tornado]

Gevent

$ pip install -e .[Gevent]

Execution

If both backends are installed, tornado is used by default. To force gevent over tornado, set the environment variable $NO_TORNADO to something.

$ NO_TORNADO=1 python script.py

Preview

The tornado Server

from pseud import Server


server = Server('service')
server.bind('tcp://127.0.0.1:5555')

@server.register_rpc
def hello(name):
    return 'Hello {0}'.format(name)

server.start()  # this will block forever

The tornado Client

# Assume the tornado IOLoop is running
from pseud import Client


client = Client('service', identity='client1', io_loop=loop)
client.connect('tcp://127.0.0.1:5555')

# Assume we are inside a coroutine
response = yield client.hello('Charly')
assert response == 'Hello Charly'

@client.register_rpc(name='draw.me.a.sheep')
def sheep():
    return 'beeeh'

The gevent Client

from pseud import Client


client = Client('service')
client.connect('tcp://127.0.0.1:5555')

assert client.hello('Charly').get() == 'Hello Charly'

The SyncClient

# to use within a non-asynchronous process or in a command interpreter
from pseud import SyncClient


client = SyncClient()
client.connect('tcp://127.0.0.1:5555')

assert client.hello('Charly') == 'Hello Charly'

The Server send a command to the client

# assume we are inside a coroutine
sheep = yield server.send_to('client1').draw.me.a.sheep()
assert sheep == 'beeeh'

Documentation

Pseud on Readthedocs

Release history Release notifications

History Node

1.0.1

History Node

1.0.0

History Node

1.0.0a1

This version
History Node

0.0.5

History Node

0.0.4

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
pseud-0.0.5-py2-none-any.whl (17.8 kB) Copy SHA256 hash SHA256 Wheel 2.7 Aug 27, 2014
pseud-0.0.5.tar.gz (13.7 kB) Copy SHA256 hash SHA256 Source None Aug 27, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page