Skip to content

Commit b7ef5ad

Browse files
committed
README / docs updates re compatibility and CLI release
1 parent 63d9634 commit b7ef5ad

File tree

3 files changed

+14
-27
lines changed

3 files changed

+14
-27
lines changed

README.rst

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -22,22 +22,11 @@ Python client for the Apache Kafka distributed stream processing system.
2222
kafka-python is designed to function much like the official java client, with a
2323
sprinkling of pythonic interfaces (e.g., consumer iterators).
2424

25-
kafka-python is best used with newer brokers (0.9+), but is backwards-compatible with
26-
older versions (to 0.8.0). Some features will only be enabled on newer brokers.
27-
For example, fully coordinated consumer groups -- i.e., dynamic partition
28-
assignment to multiple consumers in the same group -- requires use of 0.9+ kafka
29-
brokers. Supporting this feature for earlier broker releases would require
30-
writing and maintaining custom leadership election and membership / health
31-
check code (perhaps using zookeeper or consul). For older brokers, you can
32-
achieve something similar by manually assigning different partitions to each
33-
consumer instance with config management tools like chef, ansible, etc. This
34-
approach will work fine, though it does not support rebalancing on failures.
35-
See https://kafka-python.readthedocs.io/en/master/compatibility.html
36-
for more details.
37-
3825
Please note that the master branch may contain unreleased features. For release
3926
documentation, please see readthedocs and/or python's inline help.
4027

28+
New in 2.3 release: python -m kafka.* interfaces for quick scripts and testing.
29+
4130
.. code-block:: bash
4231
4332
$ pip install kafka-python
@@ -188,6 +177,14 @@ for more details.
188177
metrics = producer.metrics()
189178
190179
180+
Module CLI Interface
181+
********************
182+
183+
kafka-python also provides simple command-line interfaces for consumer, producer, and admin clients.
184+
Access via ``python -m kafka.consumer``, ``python -m kafka.producer``, and ``python -m kafka.admin``.
185+
See https://kafka-python.readthedocs.io/en/master/usage.html for more details.
186+
187+
191188
Thread safety
192189
*************
193190

docs/compatibility.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ Because the kafka server protocol is backwards compatible, kafka-python is
1313
expected to work with newer broker releases as well.
1414

1515
Although kafka-python is tested and expected to work on recent broker versions,
16-
not all features are supported. Specifically, transactional producer/consumer
17-
support is not fully implemented. PRs welcome!
16+
not all features are supported. Please see github open issues for feature tracking.
17+
PRs welcome!
1818

1919
kafka-python is tested on python 2.7, and 3.8-3.13.
2020

docs/index.rst

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,21 +16,11 @@ 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.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
22-
partition assignment to multiple consumers in the same group -- requires use of
23-
0.9 kafka brokers. Supporting this feature for earlier broker releases would
24-
require writing and maintaining custom leadership election and membership /
25-
health check code (perhaps using zookeeper or consul). For older brokers, you
26-
can achieve something similar by manually assigning different partitions to
27-
each consumer instance with config management tools like chef, ansible, etc.
28-
This approach will work fine, though it does not support rebalancing on
29-
failures. See `Compatibility <compatibility.html>`_ for more details.
30-
3119
Please note that the master branch may contain unreleased features. For release
3220
documentation, please see readthedocs and/or python's inline help.
3321

22+
New in 2.3 release: python -m kafka.* interfaces for quick scripts and testing.
23+
3424
.. code:: bash
3525
3626
pip install kafka-python

0 commit comments

Comments
 (0)