Installation

This document describes the prerequisites and the installation of .

Requirements

runs on Python on top of these networking frameworks:

You will need at least one of those.

Note

Most of Autobahn's WebSocket and WAMP features are available on both Twisted and asyncio, so you are free to choose the underlying networking framework based on your own criteria.

For Twisted installation, please see here. Asyncio comes bundled with Python 3.4+. For Python 3.3, install it from here. For Python 2, trollius will work.

Here are the configurations supported by :

Python	Twisted	asyncio	Notes
CPython 2.6	yes	yes	asyncio support via trollius
CPython 2.7	yes	yes	asyncio support via trollius
CPython 3.3	yes	yes	asyncio support via tulip
CPython 3.4+	yes	yes	asyncio in the standard library
PyPy 2.2+	yes	yes	asyncio support via trollius
Jython 2.7+	yes	?	Issues: 1, 2

Install from PyPI

To install from the Python Package Index using Pip

pip install autobahn

You can also specify install variants (see below). E.g. to install Twisted automatically as a dependency

pip install autobahn[twisted]

And to install asyncio backports automatically when required

pip install autobahn[asyncio]

Install from Sources

To install from sources, clone the repo

git clone git@github.com:tavendo/AutobahnPython.git

checkout a tagged release

cd AutobahnPython
git checkout v0.8.12

and install

cd autobahn
python setup.py install

You can also use Pip for the last step, which allows to specify install variants (see below)

pip install -e .[twisted]

Install Variants

has the following install variants:

Variant	Description
`twisted`	Install Twisted as a dependency
`asyncio`	Install asyncio as a dependency (or use stdlib)
`accelerate`	Install native acceleration packages on CPython
`compress`	Install packages for non-standard WebSocket compression methods
`serialization`	Install packages for additional WAMP serialization formats (currently MsgPack)

Install variants can be combined, e.g. to install with all optional packages for use with Twisted on CPython:

pip install autobahn[twisted,accelerate,compress,serialization]

Check the Installation

To check the installation, fire up the Python and run

>>> from autobahn import __version__ >>> print(__version__) 0.8.12

4.9 KiB Raw Blame History