summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTincu Gabriel <gabi@aiven.io>2020-09-08 01:11:18 +0200
committerGitHub <noreply@github.com>2020-09-07 16:11:18 -0700
commita27ab881726ed1a2d952867a1fa266573165d6aa (patch)
tree918d904583960e760dfaeaf89d813e789782cdb2 /docs
parent08ea21167e3d6e9577d16715eadc9829bd8c1a80 (diff)
downloadkafka-python-a27ab881726ed1a2d952867a1fa266573165d6aa.tar.gz
Add support for `zstd` compression (#2021)
Diffstat (limited to 'docs')
-rw-r--r--docs/index.rst9
1 files changed, 5 insertions, 4 deletions
diff --git a/docs/index.rst b/docs/index.rst
index fa6f93c..9c46e33 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -122,11 +122,12 @@ multiprocessing is recommended.
Compression
***********
-kafka-python supports gzip compression/decompression natively. To produce or
-consume lz4 compressed messages, you should install python-lz4 (pip install lz4).
-To enable snappy, install python-snappy (also requires snappy library).
-See `Installation <install.html#optional-snappy-install>`_ for more information.
+kafka-python supports multiple compression types:
+ - gzip : supported natively
+ - lz4 : requires `python-lz4 <https://pypi.org/project/lz4/>`_ installed
+ - snappy : requires the `python-snappy <https://pypi.org/project/python-snappy/>`_ package (which requires the snappy C library)
+ - zstd : requires the `python-zstandard <https://github.com/indygreg/python-zstandard>`_ package installed
Protocol
********