Skip to content
This repository has been archived by the owner on Mar 24, 2021. It is now read-only.

Commit

Permalink
README updates
Browse files Browse the repository at this point in the history
  • Loading branch information
emmettbutler committed May 24, 2018
1 parent 707a77d commit 8585540
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ PyKafka

.. image:: http://i.imgur.com/ztYl4lG.jpg

PyKafka is a cluster-aware Kafka>=0.8.2 client for Python. It includes Python
PyKafka is a programmer-friendly Kafka client for Python. It includes Python
implementations of Kafka producers and consumers, which are optionally backed
by a C extension built on `librdkafka`_, and runs under Python 2.7+, Python 3.4+,
and PyPy.
by a C extension built on `librdkafka`_. It runs under Python 2.7+, Python 3.4+,
and PyPy, and supports versions of Kafka 0.8.2 and newer.

.. _librdkafka: https://github.com/edenhill/librdkafka

Expand Down Expand Up @@ -73,7 +73,6 @@ them with:
.. sourcecode:: python

>>> client.topics
{'my.test': <pykafka.topic.Topic at 0x19bc8c0 (name=my.test)>}
>>> topic = client.topics['my.test']

Once you've got a `Topic`, you can create a `Producer` for it and start
Expand All @@ -90,7 +89,10 @@ returns after we have confirmation that the message made it to the cluster.

To achieve higher throughput, we recommend using the ``Producer`` in
asynchronous mode, so that ``produce()`` calls will return immediately and the
producer may opt to send messages in larger batches. You can still obtain
producer may opt to send messages in larger batches. The ``Producer`` collects
produced messages in an internal queue for ``linger_ms`` before sending each batch.
This delay can be removed or changed at the expense of efficiency with ``linger_ms``,
``min_queued_messages``, and other keyword arguments (see `readthedocs`_). You can still obtain
delivery confirmation for messages, through a queue interface which can be
enabled by setting ``delivery_reports=True``. Here's a rough usage example:

Expand Down Expand Up @@ -173,9 +175,6 @@ After that, all that's needed is that you pass an extra parameter
that some configuration options may have different optimal values; it may be
worthwhile to consult librdkafka's `configuration notes`_ for this.

We currently test against librdkafka `0.9.1`_ only. Note that use on pypy is
not recommended at this time; the producer is certainly expected to crash.

.. _0.9.1: https://github.com/edenhill/librdkafka/releases/tag/0.9.1
.. _configuration notes: https://github.com/edenhill/librdkafka/blob/0.9.1/CONFIGURATION.md

Expand Down

2 comments on commit 8585540

@rubinatorz
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @emmett9001,

You removed the remarks on librdkafka that you only test against version 0.9.1. Does this mean that pykafka now also supports newer versions? Including the newest 0.11.5?

Hope to hear from you! We definitely want to upgrade from 0.9.1 but are cautious.

Thanks!

@emmettbutler
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately, this removal was only for the purpose of streamlining the README and doesn't correspond to any other code change. We still only test against rdkafka 0.9.1.

Please sign in to comment.