Install
#######

Install with your favorite package manager

Latest Release
**************
Pip:

.. code:: bash

    pip install kafka-python

Releases are also listed at https://github.com/dpkp/kafka-python/releases


Bleeding-Edge
*************

.. code:: bash

    git clone https://github.com/dpkp/kafka-python
    pip install ./kafka-python

Setuptools:

.. code:: bash

    git clone https://github.com/dpkp/kafka-python
    easy_install ./kafka-python

Using `setup.py` directly:

.. code:: bash

    git clone https://github.com/dpkp/kafka-python
    cd kafka-python
    python setup.py install

Optional LZ4 install
********************

To enable LZ4 compression/decompression, install lz4tools and xxhash:

>>> pip install lz4tools
>>> pip install xxhash

*Note*: these modules do not support python2.6

Optional Snappy install
***********************

Install Development Libraries
=============================

Download and build Snappy from http://code.google.com/p/snappy/downloads/list

Ubuntu:

.. code:: bash

    apt-get install libsnappy-dev

OSX:

.. code:: bash

    brew install snappy

From Source:

.. code:: bash

    wget http://snappy.googlecode.com/files/snappy-1.0.5.tar.gz
    tar xzvf snappy-1.0.5.tar.gz
    cd snappy-1.0.5
    ./configure
    make
    sudo make install

Install Python Module
=====================

Install the `python-snappy` module

.. code:: bash

    pip install python-snappy
