Skip to content

Commit 31f846c

Browse files
committed
Add crc32c to README and docs
1 parent cf28da8 commit 31f846c

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

README.rst

+8
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,14 @@ To enable snappy compression/decompression install python-snappy (also requires
142142
See <https://kafka-python.readthedocs.io/en/master/install.html#optional-snappy-install>
143143
for more information.
144144

145+
Optimized CRC32 Validation
146+
**************************
147+
148+
Kafka uses CRC32 checksums to validate messages. kafka-python includes a pure
149+
python implementation for compatibility. To improve performance for high-throughput
150+
applications, kafka-python will use `crc32c` for optimized native code if installed.
151+
See https://pypi.org/project/crc32c/
152+
145153
Protocol
146154
********
147155

docs/install.rst

+8
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,14 @@ To enable LZ4 compression/decompression, install python-lz4:
3131
>>> pip install lz4
3232

3333

34+
Optional crc32c install
35+
********************
36+
37+
To enable optimized CRC32 checksum validation, install crc32c:
38+
39+
>>> pip install crc32c
40+
41+
3442
Optional Snappy install
3543
***********************
3644

0 commit comments

Comments
 (0)