diff options
| author | John Anderson <sontek@gmail.com> | 2015-02-10 11:26:56 -0800 |
|---|---|---|
| committer | John Anderson <sontek@gmail.com> | 2015-02-10 11:26:56 -0800 |
| commit | 3193d64e70c91d3cad64b0cec1b180a7a1c67ed0 (patch) | |
| tree | 2fb0a4f0c442cd32b5ed3473c5969a8a776473ad /README.rst | |
| parent | b74e8dd4657802ef1a3fd069b84bfd1e69a127f2 (diff) | |
| download | kafka-python-3193d64e70c91d3cad64b0cec1b180a7a1c67ed0.tar.gz | |
Move to .rst and use it in setup.py for long description
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..58814f0 --- /dev/null +++ b/README.rst @@ -0,0 +1,51 @@ +Kafka Python client +------------------------ +.. image:: https://api.travis-ci.org/mumrah/kafka-python.png?branch=master + :target: https://travis-ci.org/mumrah/kafka-pytho + :alt: Build Status + +.. image:: https://api.travis-ci.org/mumrah/kafka-python.png?branch=master + :target: https://coveralls.io/repos/mumrah/kafka-python/badge.svg?branch=master + :alt: Coverage Status + +.. image:: https://readthedocs.org/projects/kafka-python/badge/?version=latest + :target: http://kafka-python.readthedocs.org/en/latest/ + :alt: Full documentation available on ReadTheDocs + +`Full documentation available on ReadTheDoc`_ + +This module provides low-level protocol support for Apache Kafka as well as +high-level consumer and producer classes. Request batching is supported by the +protocol as well as broker-aware request routing. Gzip and Snappy compression +is also supported for message sets. + +http://kafka.apache.org/ + +On Freenode IRC at #kafka-python, as well as #apache-kafka + +For general discussion of kafka-client design and implementation (not python specific), +see https://groups.google.com/forum/#!forum/kafka-clients + +# License + +Copyright 2015, David Arthur under Apache License, v2.0. See `LICENSE` + +# Status + +The current stable version of this package is **`0.9.3`_** and is compatible with: + +Kafka broker versions +- 0.8.2.0 [offset management currently ZK only -- does not support ConsumerCoordinator offset management APIs] +- 0.8.1.1 +- 0.8.1 +- 0.8.0 + +Python versions +- 2.6 (tested on 2.6.9) +- 2.7 (tested on 2.7.9) +- 3.3 (tested on 3.3.5) +- 3.4 (tested on 3.4.2) +- pypy (tested on pypy 2.4.0 / python 2.7.8) + +.. _Full documentation available on ReadTheDocs: http://kafka-python.readthedocs.org/en/latest/ +.. _0.9.3: https://github.com/mumrah/kafka-python/releases/tag/v0.9.3 |