openstack/deb-python-kafka
Code Issues Proposed changes

Update README re 0.10 brokers

Browse Source
This commit is contained in:
Dana Powers
2016-05-24 13:21:04 -07:00
parent 21fe199c7b
commit fa704555df
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.rst
View File

@@ -16,10 +16,10 @@ Python client for the Apache Kafka distributed stream processing system.
kafka-python is designed to function much like the official java client, with a kafka-python is designed to function much like the official java client, with a
sprinkling of pythonic interfaces (e.g., consumer iterators). sprinkling of pythonic interfaces (e.g., consumer iterators).
kafka-python is best used with 0.9 brokers, but is backwards-compatible with 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, 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 however; for example, fully coordinated consumer groups -- i.e., dynamic partition
assignment to multiple consumers in the same group -- requires use of 0.9 kafka assignment to multiple consumers in the same group -- requires use of 0.9+ kafka
brokers. Supporting this feature for earlier broker releases would require brokers. Supporting this feature for earlier broker releases would require
writing and maintaining custom leadership election and membership / health writing and maintaining custom leadership election and membership / health
check code (perhaps using zookeeper or consul). For older brokers, you can check code (perhaps using zookeeper or consul). For older brokers, you can
@@ -38,8 +38,8 @@ KafkaConsumer
************* *************
KafkaConsumer is a high-level message consumer, intended to operate as similarly KafkaConsumer is a high-level message consumer, intended to operate as similarly
as possible to the official 0.9 java client. Full support for coordinated as possible to the official java client. Full support for coordinated
consumer groups requires use of kafka brokers that support the 0.9 Group APIs. consumer groups requires use of kafka brokers that support the Group APIs: kafka v0.9+.
See <http://kafka-python.readthedocs.org/en/master/apidoc/KafkaConsumer.html> See <http://kafka-python.readthedocs.org/en/master/apidoc/KafkaConsumer.html>
for API and configuration details. for API and configuration details.
@@ -119,7 +119,7 @@ for interacting with kafka brokers via the python repl. This is useful for
testing, probing, and general experimentation. The protocol support is testing, probing, and general experimentation. The protocol support is
leveraged to enable a KafkaClient.check_version() method that leveraged to enable a KafkaClient.check_version() method that
probes a kafka broker and attempts to identify which version it is running probes a kafka broker and attempts to identify which version it is running
(0.8.0 to 0.9). (0.8.0 to 0.10).
Low-level Low-level