Skip to content

Commit b51fc88

Browse files
committed
Update compatibility docs re: 0.11 brokers and python 3.6
1 parent 8f46ae8 commit b51fc88

File tree

3 files changed

+13
-13
lines changed

3 files changed

+13
-13
lines changed

README.rst

+5-5
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-0.10%2C%200.9%2C%200.8.2%2C%200.8.1%2C%200.8-brightgreen.svg
4+
.. image:: https://img.shields.io/badge/kafka-0.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
@@ -16,9 +16,9 @@ Python client for the Apache Kafka distributed stream processing system.
1616
kafka-python is designed to function much like the official java client, with a
1717
sprinkling of pythonic interfaces (e.g., consumer iterators).
1818

19-
kafka-python is best used with newer brokers (0.10 or 0.9), but is backwards-compatible with
20-
older versions (to 0.8.0). Some features will only be enabled on newer brokers,
21-
however; for example, fully coordinated consumer groups -- i.e., dynamic partition
19+
kafka-python is best used with newer brokers (0.9+), but is backwards-compatible with
20+
older versions (to 0.8.0). Some features will only be enabled on newer brokers.
21+
For example, fully coordinated consumer groups -- i.e., dynamic partition
2222
assignment to multiple consumers in the same group -- requires use of 0.9+ kafka
2323
brokers. Supporting this feature for earlier broker releases would require
2424
writing and maintaining custom leadership election and membership / health
@@ -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 KafkaClient.check_version() method that
138138
probes a kafka broker and attempts to identify which version it is running
139-
(0.8.0 to 0.10).
139+
(0.8.0 to 0.11).
140140

141141

142142
Low-level

docs/compatibility.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
Compatibility
22
-------------
33

4-
.. image:: https://img.shields.io/badge/kafka-0.10%2C%200.9%2C%200.8.2%2C%200.8.1%2C%200.8-brightgreen.svg
4+
.. image:: https://img.shields.io/badge/kafka-0.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 0.10
9+
kafka-python is compatible with (and tested against) broker versions 0.11
1010
through 0.8.0 . kafka-python is not compatible with the 0.8.2-beta release.
1111

12-
kafka-python is tested on python 2.7, 3.3, 3.4, 3.5, and pypy.
12+
kafka-python is tested on python 2.7, 3.4, 3.5, 3.6 and pypy.
1313

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

docs/index.rst

+5-5
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-0.10%2C%200.9%2C%200.8.2%2C%200.8.1%2C%200.8-brightgreen.svg
4+
.. image:: https://img.shields.io/badge/kafka-0.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
@@ -16,9 +16,9 @@ Python client for the Apache Kafka distributed stream processing system.
1616
kafka-python is designed to function much like the official java client, with a
1717
sprinkling of pythonic interfaces (e.g., consumer iterators).
1818

19-
kafka-python is best used with newer brokers (0.10 or 0.9), but is backwards-compatible with
20-
older versions (to 0.8.0). Some features will only be enabled on newer brokers,
21-
however; for example, fully coordinated consumer groups -- i.e., dynamic
19+
kafka-python is best used with newer brokers (0.9+), but is backwards-compatible with
20+
older versions (to 0.8.0). Some features will only be enabled on newer brokers.
21+
For example, fully coordinated consumer groups -- i.e., dynamic
2222
partition assignment to multiple consumers in the same group -- requires use of
2323
0.9 kafka brokers. Supporting this feature for earlier broker releases would
2424
require writing and maintaining custom leadership election and membership /
@@ -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 0.10).
139+
attempts to identify which version it is running (0.8.0 to 0.11).
140140

141141

142142
Low-level

0 commit comments

Comments
 (0)