This document describes the prerequisites and the installation of Autobahn.
Autobahn runs on Python on top of these networking frameworks:
You will need at least one of those.
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.5+.
Here are the configurations supported by Autobahn:
|CPython 3.5+||yes||yes||asyncio in the standard library|
|PyPy 3||yes||yes||asyncio in the standard library|
Autobahn is portable, well tuned code. You can further accelerate performance by
- Running under PyPy (recommended!) or
- on CPython, install the native accelerators wsaccel and ujson (you can use the install variant
accelerationfor that - see below)
We offer Docker Images with Autobahn pre-installed. To use this, if you have Docker already installed, just do
sudo docker run -it crossbario/autobahn-python python client.py --url ws://IP _of_WAMP_router:8080/ws --realm realm1
This starts up a Docker container and client.py, which connects to a Crossbar.io router at the given URL and to the given realm.
There are several docker images to choose from, depending on whether you are using CPython or PyPy.
There are the flavors which are based on the official CPython and PyPy images, plus versions using Alpine Linux, which have a smaller footprint. (Note: Footprint only matters for the download once per machine, after that the cached image is used. Containers off the same image/layers only take up space corresponding to how different from the image they are, so image size is relatively less important when using multiple containers.)
Install from PyPI¶
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 repository:
git clone firstname.lastname@example.org:crossbario/autobahn-python.git
checkout a tagged release:
cd AutobahnPython git checkout v0.9.1
You should only use tagged releases, not master. The latest code from master might be broken, unfinished and untested. So you have been warned ;)
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]
Autobahn has the following install variants:
||Install Twisted as a dependency|
||Install asyncio as a dependency (or use stdlib)|
||Install native acceleration packages on CPython|
||Install packages for non-standard WebSocket compression methods|
||Install packages for additional WAMP serialization formats (currently MsgPack)|
Install variants can be combined, e.g. to install Autobahn with all optional packages for use with Twisted on CPython:
pip install autobahn[twisted,accelerate,compress,serialization]
For convenience, here are minimal instructions to install both Python and Autobahn/Twisted on Windows:
Check the Installation¶
To check the installation, fire up the Python and run
>>> from autobahn import __version__ >>> print(__version__) 0.9.1
Depending on Autobahn¶
To require Autobahn as a dependency of your package, include the following in your
install_requires = ["autobahn>=0.9.1"]
You can also depend on an install variant which automatically installs dependent packages
install_requires = ["autobahn[twisted]>=0.9.1"]
The latter will automatically install Twisted as a dependency.
Where to go
Now you’ve got Autobahn installed, depending on your needs, head over to