summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDana Powers <dana.powers@rd.io>2016-01-24 22:01:09 -0800
committerDana Powers <dana.powers@rd.io>2016-01-25 10:09:15 -0800
commit0d5899020a75e22fec14d3e3d7aec8f043d60a31 (patch)
treee227d12865560026a3170196b331d4d843a9e7fd /docs
parent2c7b7452a8ca761672e70ee56b3779e4a96c1997 (diff)
downloadkafka-python-0d5899020a75e22fec14d3e3d7aec8f043d60a31.tar.gz
Add support for LZ4 compressed messages using python-lz4 module
Diffstat (limited to 'docs')
-rw-r--r--docs/install.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/install.rst b/docs/install.rst
index bf49c3f..aba5019 100644
--- a/docs/install.rst
+++ b/docs/install.rst
@@ -37,6 +37,17 @@ Using `setup.py` directly:
cd kafka-python
python setup.py install
+Optional LZ4 install
+********************
+
+To enable LZ4 compression/decompression, install `lz4`:
+
+>>> pip install lz4
+
+Or `lz4-cffi` if using pypy:
+
+>>> pip install lz4-cffi
+
Optional Snappy install
***********************