openstack/deb-python-kafka
Code Issues Proposed changes

Fix hyperlinks in README to fix pypi rendering

Browse Source
This commit is contained in:
Dana Powers
2016-04-24 23:38:28 -07:00
parent be83420636
commit dcd369ed6a
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

@@ -26,7 +26,7 @@ check code (perhaps using zookeeper or consul). For older brokers, you can
achieve something similar by manually assigning different partitions to each achieve something similar by manually assigning different partitions to each
consumer instance with config management tools like chef, ansible, etc. This consumer instance with config management tools like chef, ansible, etc. This
approach will work fine, though it does not support rebalancing on failures. approach will work fine, though it does not support rebalancing on failures.
See `Compatibility <http://kafka-python.readthedocs.org/en/master/compatibility.html>`_ See <http://kafka-python.readthedocs.org/en/master/compatibility.html>
for more details. for more details.
Please note that the master branch may contain unreleased features. For release Please note that the master branch may contain unreleased features. For release
@@ -41,7 +41,7 @@ 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 0.9 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 0.9 Group APIs.
See `ReadTheDocs <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.
The consumer iterator returns ConsumerRecords, which are simple namedtuples The consumer iterator returns ConsumerRecords, which are simple namedtuples
@@ -70,7 +70,7 @@ KafkaProducer
KafkaProducer is a high-level, asynchronous message producer. The class is KafkaProducer is a high-level, asynchronous message producer. The class is
intended to operate as similarly as possible to the official java client. intended to operate as similarly as possible to the official java client.
See `ReadTheDocs <http://kafka-python.readthedocs.org/en/master/apidoc/KafkaProducer.html>`_ See <http://kafka-python.readthedocs.org/en/master/apidoc/KafkaProducer.html>
for more details. for more details.
>>> from kafka import KafkaProducer >>> from kafka import KafkaProducer
@@ -108,7 +108,7 @@ kafka-python supports gzip compression/decompression natively. To produce or
consume lz4 compressed messages, you must install lz4tools and xxhash (modules consume lz4 compressed messages, you must install lz4tools and xxhash (modules
may not work on python2.6). To enable snappy compression/decompression install may not work on python2.6). To enable snappy compression/decompression install
python-snappy (also requires snappy library). python-snappy (also requires snappy library).
See `Installation <http://kafka-python.readthedocs.org/en/master/install.html#optional-snappy-install>`_ See <http://kafka-python.readthedocs.org/en/master/install.html#optional-snappy-install>
for more information. for more information.
Protocol Protocol
@@ -127,4 +127,4 @@ Low-level
Legacy support is maintained for low-level consumer and producer classes, Legacy support is maintained for low-level consumer and producer classes,
SimpleConsumer and SimpleProducer. See SimpleConsumer and SimpleProducer. See
`ReadTheDocs <http://kafka-python.readthedocs.org/master/>`_ for API details. <http://kafka-python.readthedocs.org/master/> for API details.