summaryrefslogtreecommitdiff
path: root/README.rst
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 /README.rst
parent2c7b7452a8ca761672e70ee56b3779e4a96c1997 (diff)
downloadkafka-python-0d5899020a75e22fec14d3e3d7aec8f043d60a31.tar.gz
Add support for LZ4 compressed messages using python-lz4 module
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 1d04e0b..2bcc150 100644
--- a/README.rst
+++ b/README.rst
@@ -79,6 +79,14 @@ for more details.
>>> for i in range(1000):
... producer.send('foobar', b'msg %d' % i)
+Compression
+***********
+
+kafka-python supports gzip compression/decompression natively. To produce or
+consume snappy and lz4 compressed messages, you must install `lz4` (`lz4-cffi`
+if using pypy) and/or `python-snappy` (also requires snappy library).
+See `Installation <http://kafka-python.readthedocs.org/en/master/install.html#optional-snappy-install>`_
+for more information.
Protocol
********