summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDana Powers <dana.powers@gmail.com>2017-08-13 13:35:13 -0700
committerDana Powers <dana.powers@gmail.com>2017-08-13 13:35:13 -0700
commitb51fc8820301d11ac0c8ea72daa8facab7d469a9 (patch)
tree9cf0357c69fe275ea95877afe6d0ece5acd05b2f
parent8f46ae8489fffad6afa62c153c46d70f8e621044 (diff)
downloadkafka-python-b51fc8820301d11ac0c8ea72daa8facab7d469a9.tar.gz
Update compatibility docs re: 0.11 brokers and python 3.6
-rw-r--r--README.rst10
-rw-r--r--docs/compatibility.rst6
-rw-r--r--docs/index.rst10
3 files changed, 13 insertions, 13 deletions
diff --git a/README.rst b/README.rst
index 751a524..6e9a507 100644
--- a/README.rst
+++ b/README.rst
@@ -1,7 +1,7 @@
Kafka Python client
------------------------
-.. 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
+.. image:: https://img.shields.io/badge/kafka-0.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
@@ -16,9 +16,9 @@ Python client for the Apache Kafka distributed stream processing system.
kafka-python is designed to function much like the official java client, with a
sprinkling of pythonic interfaces (e.g., consumer iterators).
-kafka-python is best used with newer brokers (0.10 or 0.9), but is backwards-compatible with
-older versions (to 0.8.0). Some features will only be enabled on newer brokers,
-however; for example, fully coordinated consumer groups -- i.e., dynamic partition
+kafka-python is best used with newer brokers (0.9+), but is backwards-compatible with
+older versions (to 0.8.0). Some features will only be enabled on newer brokers.
+For example, fully coordinated consumer groups -- i.e., dynamic partition
assignment to multiple consumers in the same group -- requires use of 0.9+ kafka
brokers. Supporting this feature for earlier broker releases would require
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
testing, probing, and general experimentation. The protocol support is
leveraged to enable a KafkaClient.check_version() method that
probes a kafka broker and attempts to identify which version it is running
-(0.8.0 to 0.10).
+(0.8.0 to 0.11).
Low-level
diff --git a/docs/compatibility.rst b/docs/compatibility.rst
index 124af18..a832ae6 100644
--- a/docs/compatibility.rst
+++ b/docs/compatibility.rst
@@ -1,14 +1,14 @@
Compatibility
-------------
-.. 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
+.. image:: https://img.shields.io/badge/kafka-0.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 0.10
+kafka-python is compatible with (and tested against) broker versions 0.11
through 0.8.0 . kafka-python is not compatible with the 0.8.2-beta release.
-kafka-python is tested on python 2.7, 3.3, 3.4, 3.5, and pypy.
+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 550d246..f84992a 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,7 +1,7 @@
kafka-python
############
-.. 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
+.. image:: https://img.shields.io/badge/kafka-0.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
@@ -16,9 +16,9 @@ Python client for the Apache Kafka distributed stream processing system.
kafka-python is designed to function much like the official java client, with a
sprinkling of pythonic interfaces (e.g., consumer iterators).
-kafka-python is best used with newer brokers (0.10 or 0.9), but is backwards-compatible with
-older versions (to 0.8.0). Some features will only be enabled on newer brokers,
-however; for example, fully coordinated consumer groups -- i.e., dynamic
+kafka-python is best used with newer brokers (0.9+), but is backwards-compatible with
+older versions (to 0.8.0). Some features will only be enabled on newer brokers.
+For example, fully coordinated consumer groups -- i.e., dynamic
partition assignment to multiple consumers in the same group -- requires use of
0.9 kafka brokers. Supporting this feature for earlier broker releases would
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
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 0.10).
+attempts to identify which version it is running (0.8.0 to 0.11).
Low-level