diff options
| author | Jeff Widman <jeff@jeffwidman.com> | 2020-11-15 12:10:12 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-11-15 12:10:12 -0800 |
| commit | b0c59303fc71c287b001c83ca123d57c58085f1a (patch) | |
| tree | dcf841b0daab44ac21ac32804e995f420113658d /docs/install.rst | |
| parent | 8b8a48ba09677e38088c61ade2dab2e42198ab3f (diff) | |
| download | kafka-python-b0c59303fc71c287b001c83ca123d57c58085f1a.tar.gz | |
Cleanup install instructions for optional libs (#2139)
This cleans up the install instructions to specify that optional libs
should be installed using the `kafka-python[opt]` format. This leverages
`setuptools`' `extra_requires` feature to let our users choose to
inherit any versions pins we might apply to our optional dependencies.
This also re-orders the docs slightly to give more visibility to the
`crc32c` install because users are unlikely to realize it exists.
It also cleans up the formatting of the compression libraries slightly,
as they were getting a little unwieldy.
Diffstat (limited to 'docs/install.rst')
| -rw-r--r-- | docs/install.rst | 40 |
1 files changed, 20 insertions, 20 deletions
diff --git a/docs/install.rst b/docs/install.rst index 200ca17..19901ee 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -23,20 +23,33 @@ Bleeding-Edge pip install ./kafka-python -Optional LZ4 install +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 the `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 'kafka-python[crc32c]' + + +Optional ZSTD install ******************** -To enable LZ4 compression/decompression, install python-lz4: +To enable ZSTD compression/decompression, install python-zstandard: ->>> pip install lz4 +>>> pip install 'kafka-python[zstd]' -Optional crc32c install +Optional LZ4 install ******************** -To enable optimized CRC32 checksum validation, install crc32c: +To enable LZ4 compression/decompression, install python-lz4: ->>> pip install crc32c +>>> pip install 'kafka-python[lz4]' Optional Snappy install @@ -77,17 +90,4 @@ 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 + pip install 'kafka-python[snappy]' |