diff options
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..82c3f57 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,59 @@ + +kafka-python +============ + +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/m/#!forum/kafka-clients + +Status +------ + +The current stable version of this package is `0.9.2 <https://github.com/mumrah/kafka-python/releases/tag/v0.9.2>`_ and is compatible with: + +Kafka broker versions + +* 0.8.0 +* 0.8.1 +* 0.8.1.1 + +Python versions + +* 2.6 (tested on 2.6.9) +* 2.7 (tested on 2.7.8) +* pypy (tested on pypy 2.3.1 / python 2.7.6) +* (Python 3.3 and 3.4 support has been added to trunk and will be available the next release) + +License +------- + +Copyright 2014, David Arthur under Apache License, v2.0. See `LICENSE <https://github.com/mumrah/kafka-python/blob/master/LICENSE>`_. + + +Contents +-------- + +.. toctree:: + :maxdepth: 2 + + install + tests + usage + api_reference + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + |