diff options
author | Taras <voyn1991@gmail.com> | 2018-02-21 20:23:45 +0200 |
---|---|---|
committer | Taras <voyn1991@gmail.com> | 2018-02-21 20:23:45 +0200 |
commit | 00554efb253402400f9331c329303aecf48cc86e (patch) | |
tree | 2677b669fbe72468383c04f801972fbcb1b7a38a /docs | |
parent | 53b0c70ebc208d843e1660a9ee57fd2e615efb16 (diff) | |
download | kafka-python-hw_crc32c.tar.gz |
Add doc notice of optional `crc32c` packagehw_crc32c
Diffstat (limited to 'docs')
-rw-r--r-- | docs/install.rst | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/install.rst b/docs/install.rst index cc0e82d..fe740f6 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -70,3 +70,16 @@ Install the `python-snappy` module .. code:: bash pip install python-snappy + + +Optional crc32c install +*********************** +Highly recommended if you are using Kafka 11+ brokers. For those `kafka-python` +uses a new message protocol version, that requires calculation of `crc32c`, +which differs from `zlib.crc32` hash implementation. By default `kafka-python` +calculates it in pure python, which is quite slow. To speed it up we optionally +support https://pypi.python.org/pypi/crc32c package if it's installed. + +.. code:: bash + + pip install crc32c |