Skip to content

Commit 45196e3

Browse files
committed
Update kafka broker compatibility docs
1 parent 4c520db commit 45196e3

File tree

3 files changed

+9
-6
lines changed

3 files changed

+9
-6
lines changed

README.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Kafka Python client
22
------------------------
33

4-
.. image:: https://img.shields.io/badge/kafka-1.0%2C%200.11%2C%200.10%2C%200.9%2C%200.8-brightgreen.svg
4+
.. 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
55
:target: https://kafka-python.readthedocs.io/compatibility.html
66
.. image:: https://img.shields.io/pypi/pyversions/kafka-python.svg
77
:target: https://pypi.python.org/pypi/kafka-python
@@ -150,7 +150,7 @@ for interacting with kafka brokers via the python repl. This is useful for
150150
testing, probing, and general experimentation. The protocol support is
151151
leveraged to enable a KafkaClient.check_version() method that
152152
probes a kafka broker and attempts to identify which version it is running
153-
(0.8.0 to 1.0).
153+
(0.8.0 to 1.1+).
154154

155155
Low-level
156156
*********

docs/compatibility.rst

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
Compatibility
22
-------------
33

4-
.. image:: https://img.shields.io/badge/kafka-1.0%2C%200.11%2C%200.10%2C%200.9%2C%200.8-brightgreen.svg
4+
.. 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
55
:target: https://kafka-python.readthedocs.io/compatibility.html
66
.. image:: https://img.shields.io/pypi/pyversions/kafka-python.svg
77
:target: https://pypi.python.org/pypi/kafka-python
88

9-
kafka-python is compatible with (and tested against) broker versions 1.0
9+
kafka-python is compatible with (and tested against) broker versions 1.1
1010
through 0.8.0 . kafka-python is not compatible with the 0.8.2-beta release.
1111

12+
Because the kafka server protocol is backwards compatible, kafka-python is
13+
expected to work with newer broker releases as well (2.0+).
14+
1215
kafka-python is tested on python 2.7, 3.4, 3.5, 3.6 and pypy.
1316

1417
Builds and tests via Travis-CI. See https://travis-ci.org/dpkp/kafka-python

docs/index.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
kafka-python
22
############
33

4-
.. image:: https://img.shields.io/badge/kafka-1.0%2C%200.11%2C%200.10%2C%200.9%2C%200.8-brightgreen.svg
4+
.. 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
55
:target: https://kafka-python.readthedocs.io/compatibility.html
66
.. image:: https://img.shields.io/pypi/pyversions/kafka-python.svg
77
: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
136136
testing, probing, and general experimentation. The protocol support is
137137
leveraged to enable a :meth:`~kafka.KafkaClient.check_version()`
138138
method that probes a kafka broker and
139-
attempts to identify which version it is running (0.8.0 to 1.0).
139+
attempts to identify which version it is running (0.8.0 to 1.1+).
140140

141141

142142
Low-level

0 commit comments

Comments
 (0)