Source Code

The git repository is at: http://github.com/zeromq/pyzmq. You can download the PyØMQ source code as a zip or tar package, or clone the git repository:

git clone git://github.com/zeromq/pyzmq.git

Build and installation

You will first need to install the latest ØMQ from the development trunk here:

http://github.com/zeromq/zeromq2

Then download the PyØMQ source and cd to its top-level directory:

$ cd pyzmq

Next, copy setup.cfg.template to setup.cfg and edit that new file to define the library_dir and include_dirs variables to point to your ØMQ installation:

[build_ext]
# Edit these to point to your installed zeromq library and header dirs.
library_dirs = /usr/local/zeromq2-dev/lib
include_dirs = /usr/local/zeromq2-dev/include

If you did a standard make, ØMQ will be in /usr/local/lib and /usr/local/include.

Finally install the package by running:

$ python setup.py install

You may have to run this last command with sudo.

Under Linux, you will need the python-dev package installed.

Windows

Building on Windows requires either MinGW or MSVC 2008. The steps are mostly the same as for POSIX platforms, however, you will need to copy the ØMQ library libzmq.dll to pyzmq\zmq before building. Please contact us if you have difficulties building or using PyØMQ on Windows.

Documentation

The README file of the source code is the best documentation for now.

We are developing Sphinx based documentation in the source tree here:

http://github.com/ellisonbg/pyzmq/tree/master/docs/

Eventually we will post the HTML and PDF output of these docs online.

Test Suite

PyØMQ has an integrated test suite. To run the test suite simple do:

$ python setup.py test

This requires an inplace build. You can also run the test suite with nose or py.test.

Bug Reporting

If you encounter problems please fill a bug report at:

http://github.com/zeromq/pyzmq/issues

or write an e-mail to:

ellisonbg AT gmail DOT com

Mailing List

Discussions about this language binding take place on the general zeromq-dev list.