PyZMQ: Python bindings for 0MQ
This package contains Python bindings for 0MQ. 0MQ is a lightweight and fast messaging implementation.
Current release of pyzmq is 2.1.4, and targets libzmq-2.1.4. For zeromq 2.0.10 or maint branch, use pyzmq release 220.127.116.11 or the 2.0.x development branch.
PyZMQ versioning follows 0MQ versioning. In general, your pyzmq version should be the same as that of your libzmq, but due to the generally growing API of zeromq, your pyzmq should not be newer than your zeromq. This is a strict restriction for pyzmq <= 2.1.0, but we intend to support zeromq >= 2.1.0 for pyzmq 2.1.x.
See PyZMQ's Sphinx generated documentation on GitHub for API details, and some notes on Python and Cython development.
Unless you specifically want to develop PyZMQ, we recommend downloading the PyZMQ source code from our github download page here:
While you can also get the latest source code by forking our github repository, building from the repository will require that you download and install Cython version 0.13 or later.
Building and installation
To build and install this Python package, you will first need to build and install the latest development version of 0MQ itself. After you have done this, follow these steps:
Tell pyzmq where zeromq is via the configure subcommand:
$ python setup.py configure --zmq=/path/to/zeromq2
or the zmq install directory on OSX/Linux:
$ python setup.py configure --zmq=/usr/local
The argument should be a directory containing a
lib and a
include directory, containing
Second, run this command:
$ python setup.py install
Cython is not required to build pyzmq from a release package, but it is required if you want to develop pyzmq, or build directly from our repository on GitHub.
On Windows, libzmq.dll will be copied into the zmq directory, and installed along with pyzmq, so you shouldn't need to edit your PATH.
It is best to compile both ØMQ and PyØMQ with Microsoft Visual Studio 2008 or above. You should not need to use mingw.
Current testing indicates that running
$ python setup.py bdist_msi
successfully builds an MSI installer.
If you install libzmq to a location other than the default (
/usr/local) on Linux,
you may need to do one of the following:
LD_LIBRARY_PATHto point to the
libdirectory of 0MQ.
Build the extension using the
$ python setup.py build_ext --rpath=/opt/zeromq-dev/lib --inplace
To develop PyZMQ, you will need to install Cython, version 0.13 or greater.
After installing Cython, instead of doing
python setup.py install do:
$ python setup.py build_ext --inplace $ python setupegg.py develop
This will build the C extension inplace and then put this directory on your
sys.path. With this configuration you only have to run:
$ python setup.py build_ext --inplace
each time you change the
.pyx files. To clean the sources, you can do:
$ python setup.py clean
To run the test suite after installing, just do:
$ python setup.py test
How to release PyZMQ
Currently, we are using the following steps to release PyZMQ:
Check the version number in
Register the release with pypi:
python setup.py register
Build source distributions and upload:
python setup.py sdist --formats=zip,gztar upload
Upload the tarball and
.zipfile to github.
Branch the release:
git checkout -b 2.1.4 master git push origin 2.1.4
Tag the release:
git tag -a -m "Tagging release 2.1.4" v2.1.4 git push origin --tags
Make sure the
README.rsthas an updated list of contributors.
Announce on list.
This project was started by and continues to be led by Brian E. Granger (ellisonbg AT gmail DOT com).
The following people have contributed to the project:
- Carlos Rocha (carlos DOT rocha AT gmail DOT com)
- Andrew Gwozdziewycz (git AT apgwoz DOT com)
- Fernando Perez (fernando DOT perez AT berkeley DOT edu)
- Nicholas Piel (nicholas AT nichol DOT as)
- Eugene Chernyshov (chernyshov DOT eugene AT gmail DOT com)
- Justin Riley (justin DOT t DOT riley AT gmail DOT com)
- Ivo Danihelka (ivo AT denihelka DOT net)
- Thomas Supra (tomspur AT fedoraproject DOT org)
- Douglas Creager (dcreager AT dcreager DOT net)
- Erick Tryzelaar (erick DOT tryzelaar AT gmail DOT com)
- Min Ragan-Kelley (benjaminrk AT gmail DOT com)
- Scott Sadler (github AT mashi DOT org)
- spez (steve AT hipmunk DOT com)
- Thomas Kluyver (takowl AT gmail DOT com)
- Baptiste Lepilleur (baptiste DOT lepilleur AT gmail DOT com)