RETIRED, further work has moved to Debian project infrastructure
Go to file
Tobias Oberstein 9ad7878e0c prepare for release (#874) 2017-07-21 13:58:54 +02:00
autobahn prepare for release (#874) 2017-07-21 13:58:54 +02:00
docs prepare for release (#874) 2017-07-21 13:58:54 +02:00
examples Newapi asyncio component (#872) 2017-07-19 14:15:26 +02:00
twisted/plugins copyrights transferred from Tavendo to Crossbar.io Technologies 2016-11-07 12:20:15 +01:00
wstest polish 2017-03-23 18:46:49 +01:00
.coveragerc tox and travis improvements 2015-08-14 11:26:47 +08:00
.gitignore Ensuring drop reason always gets propogated 2017-05-13 12:25:09 -07:00
.travis.yml test against Twitsed 16.5.0 2016-11-07 12:42:38 +01:00
DEVELOPERS.md fix #786 2017-03-18 23:14:32 +01:00
LICENSE copyrights transferred from Tavendo to Crossbar.io Technologies 2016-11-07 12:20:15 +01:00
MANIFEST.in fix tox; cleanup 2015-03-10 00:18:09 +01:00
Makefile skip on json binary conversion on py2 for now 2017-04-05 13:34:26 +02:00
README.rst add docker badge 2017-05-02 14:06:32 +02:00
requirements-rtd.txt fix RTD 2016-05-01 13:43:43 +02:00
setup.cfg Make tests compatible with pytest3 2016-10-01 19:47:03 +02:00
setup.py prepare release (#847) 2017-06-08 17:32:07 +02:00
tox.ini prepare release (#847) 2017-06-08 17:32:07 +02:00

README.rst

Autobahn|Python

WebSocket & WAMP for Python on Twisted and asyncio.

Version Build Status Coverage Docs Docker

Introduction

Autobahn|Python is a subproject of Autobahn and provides open-source implementations of

for Python 2 and 3, and running on Twisted and asyncio.

You can use Autobahn|Python to create clients and servers in Python speaking just plain WebSocket or WAMP.

WebSocket allows bidirectional real-time messaging on the Web and beyond, while WAMP adds real-time application communication on top of WebSocket.

WAMP provides asynchronous Remote Procedure Calls and Publish & Subscribe for applications in one protocol running over WebSocket. WAMP is a routed protocol, so you need a WAMP Router to connect your Autobahn|Python based clients. We provide Crossbar.io, but there are other options as well.

Features

Show me some code

To give you a first impression, here are two examples. We have lot more in the repo.

WebSocket Echo Server

Here is a simple WebSocket Echo Server that will echo back any WebSocket message received:

from autobahn.twisted.websocket import WebSocketServerProtocol
# or: from autobahn.asyncio.websocket import WebSocketServerProtocol

class MyServerProtocol(WebSocketServerProtocol):

    def onConnect(self, request):
        print("Client connecting: {}".format(request.peer))

    def onOpen(self):
        print("WebSocket connection open.")

    def onMessage(self, payload, isBinary):
        if isBinary:
            print("Binary message received: {} bytes".format(len(payload)))
        else:
            print("Text message received: {}".format(payload.decode('utf8')))

        # echo back message verbatim
        self.sendMessage(payload, isBinary)

    def onClose(self, wasClean, code, reason):
        print("WebSocket connection closed: {}".format(reason))

To actually run above server protocol, you need some lines of boilerplate.

WAMP Application Component

Here is a WAMP Application Component that performs all four types of actions that WAMP provides:

  1. subscribe to a topic
  2. publish an event
  3. register a procedure
  4. call a procedure
from autobahn.twisted.wamp import ApplicationSession
# or: from autobahn.asyncio.wamp import ApplicationSession

class MyComponent(ApplicationSession):

    @inlineCallbacks
    def onJoin(self, details):

        # 1. subscribe to a topic so we receive events
        def onevent(msg):
            print("Got event: {}".format(msg))

        yield self.subscribe(onevent, 'com.myapp.hello')

        # 2. publish an event to a topic
        self.publish('com.myapp.hello', 'Hello, world!')

        # 3. register a procedure for remote calling
        def add2(x, y):
            return x + y

        self.register(add2, 'com.myapp.add2');

        # 4. call a remote procedure
        res = yield self.call('com.myapp.add2', 2, 3)
        print("Got result: {}".format(res))

Above code will work on Twisted and asyncio by changing a single line (the base class of MyComponent). To actually run above application component, you need some lines of boilerplate and a WAMP Router.