Skip to main content

Pure Python client for Apache Kafka

Project description

https://coveralls.io/repos/dpkp/kafka-python/badge.svg?branch=master&service=github https://travis-ci.org/dpkp/kafka-python.svg?branch=master
>>> pip install kafka-python

kafka-python is a client for the Apache Kafka distributed stream processing system. It is designed to function much like the official java client, with a sprinkling of pythonic interfaces (e.g., iterators).

KafkaConsumer

>>> from kafka import KafkaConsumer
>>> consumer = KafkaConsumer('my_favorite_topic')
>>> for msg in consumer:
...     print (msg)

KafkaConsumer is a full-featured, high-level message consumer class that is similar in design and function to the new 0.9 java consumer. Most configuration parameters defined by the official java client are supported as optional kwargs, with generally similar behavior. Gzip and Snappy compressed messages are supported transparently.

In addition to the standard KafkaConsumer.poll() interface (which returns micro-batches of messages, grouped by topic-partition), kafka-python supports single-message iteration, yielding ConsumerRecord namedtuples, which include the topic, partition, offset, key, and value of each message.

By default, KafkaConsumer will attempt to auto-commit message offsets every 5 seconds. When used with 0.9 kafka brokers, KafkaConsumer will dynamically assign partitions using the kafka GroupCoordinator APIs and a RoundRobinPartitionAssignor partitioning strategy, enabling relatively straightforward parallel consumption patterns. See ReadTheDocs for examples.

KafkaProducer

<in progress - see SimpleProducer for legacy producer implementation>

Protocol

A secondary goal of kafka-python is to provide an easy-to-use protocol layer for interacting with kafka brokers via the python repl. This is useful for testing, probing, and general experimentation. The protocol support is leveraged to enable a KafkaClient.check_version() method that probes a kafka broker and attempts to identify which version it is running (0.8.0 to 0.9).

Low-level

Legacy support is maintained for low-level consumer and producer classes, SimpleConsumer and SimpleProducer. See ReadTheDocs for API details.

Project details


Release history Release notifications

This version
History Node

0.9.8

History Node

0.9.7

History Node

0.9.6

History Node

0.9.5

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
gc-kafka-python-0.9.8.tar.gz (123.4 kB) Copy SHA256 hash SHA256 Source None Jan 11, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page