diff options
| author | Dana Powers <dana.powers@gmail.com> | 2018-11-20 08:36:38 -0800 |
|---|---|---|
| committer | Dana Powers <dana.powers@gmail.com> | 2018-11-20 08:36:38 -0800 |
| commit | 45196e31d5cbd4da02a81f0c459faee1f8165306 (patch) | |
| tree | 797651b6eaa61f4847d2a24625fed53f9dbd73fb /docs | |
| parent | 4c520db3c572bb23078bb6813733a5b6457be771 (diff) | |
| download | kafka-python-45196e31d5cbd4da02a81f0c459faee1f8165306.tar.gz | |
Update kafka broker compatibility docs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/compatibility.rst | 7 | ||||
| -rw-r--r-- | docs/index.rst | 4 |
2 files changed, 7 insertions, 4 deletions
diff --git a/docs/compatibility.rst b/docs/compatibility.rst index 1771d8f..85b2c59 100644 --- a/docs/compatibility.rst +++ b/docs/compatibility.rst @@ -1,14 +1,17 @@ Compatibility ------------- -.. image:: https://img.shields.io/badge/kafka-1.0%2C%200.11%2C%200.10%2C%200.9%2C%200.8-brightgreen.svg +.. image:: https://img.shields.io/badge/kafka-1.1%2C%201.0%2C%200.11%2C%200.10%2C%200.9%2C%200.8-brightgreen.svg :target: https://kafka-python.readthedocs.io/compatibility.html .. image:: https://img.shields.io/pypi/pyversions/kafka-python.svg :target: https://pypi.python.org/pypi/kafka-python -kafka-python is compatible with (and tested against) broker versions 1.0 +kafka-python is compatible with (and tested against) broker versions 1.1 through 0.8.0 . kafka-python is not compatible with the 0.8.2-beta release. +Because the kafka server protocol is backwards compatible, kafka-python is +expected to work with newer broker releases as well (2.0+). + kafka-python is tested on python 2.7, 3.4, 3.5, 3.6 and pypy. Builds and tests via Travis-CI. See https://travis-ci.org/dpkp/kafka-python diff --git a/docs/index.rst b/docs/index.rst index 51c39f5..0b5b53f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,7 +1,7 @@ kafka-python ############ -.. image:: https://img.shields.io/badge/kafka-1.0%2C%200.11%2C%200.10%2C%200.9%2C%200.8-brightgreen.svg +.. image:: https://img.shields.io/badge/kafka-1.1%2C%201.0%2C%200.11%2C%200.10%2C%200.9%2C%200.8-brightgreen.svg :target: https://kafka-python.readthedocs.io/compatibility.html .. image:: https://img.shields.io/pypi/pyversions/kafka-python.svg :target: https://pypi.python.org/pypi/kafka-python @@ -136,7 +136,7 @@ for interacting with kafka brokers via the python repl. This is useful for testing, probing, and general experimentation. The protocol support is leveraged to enable a :meth:`~kafka.KafkaClient.check_version()` method that probes a kafka broker and -attempts to identify which version it is running (0.8.0 to 1.0). +attempts to identify which version it is running (0.8.0 to 1.1+). Low-level |