summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDana Powers <dana.powers@gmail.com>2019-09-30 13:16:40 -0700
committerGitHub <noreply@github.com>2019-09-30 13:16:40 -0700
commit0a8884b984b37a8b46e5b17eabaee894113d7b59 (patch)
tree964aa5bef99d66270b5b7379f270bce9f843bdc8 /docs
parent975087b4ae22ecdb63b757a5abe2e9643888b7fe (diff)
downloadkafka-python-0a8884b984b37a8b46e5b17eabaee894113d7b59.tar.gz
Add KAFKA 2.3.0 to test matrix (#1915)
Diffstat (limited to 'docs')
-rw-r--r--docs/compatibility.rst10
-rw-r--r--docs/index.rst4
2 files changed, 9 insertions, 5 deletions
diff --git a/docs/compatibility.rst b/docs/compatibility.rst
index fc9e7cc..9ab877f 100644
--- a/docs/compatibility.rst
+++ b/docs/compatibility.rst
@@ -1,16 +1,20 @@
Compatibility
-------------
-.. 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
+.. image:: https://img.shields.io/badge/kafka-2.3%2C%202.2%2C%202.1%2C%202.0%2C%201.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.1
+kafka-python is compatible with (and tested against) broker versions 2.3
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+).
+expected to work with newer broker releases as well.
+
+Although kafka-python is tested and expected to work on recent broker versions,
+not all features are supported. Specifically, authentication codecs, and
+transactional producer/consumer support are not fully implemented. PRs welcome!
kafka-python is tested on python 2.7, 3.4, 3.7, and pypy2.7.
diff --git a/docs/index.rst b/docs/index.rst
index 0b5b53f..6fa9a0c 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,7 +1,7 @@
kafka-python
############
-.. 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
+.. image:: https://img.shields.io/badge/kafka-2.3%2C%202.2%2C%202.1%2C%202.0%2C%201.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.1+).
+attempts to identify which version it is running (0.8.0 to 2.3+).
Low-level