summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDana Powers <dana.powers@gmail.com>2019-12-29 12:41:36 -0800
committerDana Powers <dana.powers@gmail.com>2019-12-29 12:41:36 -0800
commit31f846c782b9dc6f2107340d269a7558e99bdfe2 (patch)
tree0063b5301b3f89da28d75461b2d5437370c8b640
parentcf28da8420b007d836b0db9d865d74fee89cdbcd (diff)
downloadkafka-python-31f846c782b9dc6f2107340d269a7558e99bdfe2.tar.gz
Add crc32c to README and docs
-rw-r--r--README.rst8
-rw-r--r--docs/install.rst8
2 files changed, 16 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index f8947eb..c4f7f8b 100644
--- a/README.rst
+++ b/README.rst
@@ -142,6 +142,14 @@ To enable snappy compression/decompression install python-snappy (also requires
See <https://kafka-python.readthedocs.io/en/master/install.html#optional-snappy-install>
for more information.
+Optimized CRC32 Validation
+**************************
+
+Kafka uses CRC32 checksums to validate messages. kafka-python includes a pure
+python implementation for compatibility. To improve performance for high-throughput
+applications, kafka-python will use `crc32c` for optimized native code if installed.
+See https://pypi.org/project/crc32c/
+
Protocol
********
diff --git a/docs/install.rst b/docs/install.rst
index d6473ec..200ca17 100644
--- a/docs/install.rst
+++ b/docs/install.rst
@@ -31,6 +31,14 @@ To enable LZ4 compression/decompression, install python-lz4:
>>> pip install lz4
+Optional crc32c install
+********************
+
+To enable optimized CRC32 checksum validation, install crc32c:
+
+>>> pip install crc32c
+
+
Optional Snappy install
***********************