README.rst


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

Kafka Python client
------------------------
.. image:: https://api.travis-ci.org/mumrah/kafka-python.png?branch=master
    :target: https://travis-ci.org/mumrah/kafka-python
    :alt: Build Status

.. image:: https://coveralls.io/r/mumrah/kafka-python?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 ReadTheDocs`_

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