Kafka Python client
------------------------
.. image:: https://img.shields.io/badge/kafka-2.6%2C%202.5%2C%202.4%2C%202.3%2C%202.2%2C%202.1%2C%202.0%2C%201.1%2C%201.0%2C%200.11%2C%200.10%2C%200.9%2C%200.8-brightgreen.svg
:target: https://kafka-python.readthedocs.io/en/master/compatibility.html
.. image:: https://img.shields.io/pypi/pyversions/kafka-python.svg
:target: https://pypi.python.org/pypi/kafka-python
.. image:: https://coveralls.io/repos/dpkp/kafka-python/badge.svg?branch=master&service=github
:target: https://coveralls.io/github/dpkp/kafka-python?branch=master
.. image:: https://travis-ci.org/dpkp/kafka-python.svg?branch=master
:target: https://travis-ci.org/dpkp/kafka-python
.. image:: https://img.shields.io/badge/license-Apache%202-blue.svg
:target: https://github.com/dpkp/kafka-python/blob/master/LICENSE
Python client for the Apache Kafka distributed stream processing system.
kafka-python is designed to function much like the official java client, with a
sprinkling of pythonic interfaces (e.g., consumer iterators).
kafka-python is best used with newer brokers (0.9+), but is backwards-compatible with
older versions (to 0.8.0). Some features will only be enabled on newer brokers.
For example, fully coordinated consumer groups -- i.e., dynamic partition
assignment to multiple consumers in the same group -- requires use of 0.9+ kafka
brokers. Supporting this feature for earlier broker releases would require
writing and maintaining custom leadership election and membership / health
check code (perhaps using zookeeper or consul). For older brokers, you can
achieve something similar by manually assigning different partitions to each
consumer instance with config management tools like chef, ansible, etc. This
approach will work fine, though it does not support rebalancing on failures.
See <https://kafka-python.readthedocs.io/en/master/compatibility.html>
for more details.
Please note that the master branch may contain unreleased features. For release
documentation, please see readthedocs and/or python's inline help.
>>> pip install kafka-python
KafkaConsumer
*************
KafkaConsumer is a high-level message consumer, intended to operate as similarly
as possible to the official java client. Full support for coordinated
consumer groups requires use of kafka brokers that support the Group APIs: kafka v0.9+.
See <https://kafka-python.readthedocs.io/en/master/apidoc/KafkaConsumer.html>
for API and configuration details.
The consumer iterator returns ConsumerRecords, which are simple namedtuples
that expose basic message attributes: topic, partition, offset, key, and value:
>>> from kafka3 import KafkaConsumer
>>> consumer = KafkaConsumer('my_favorite_topic')
>>> for msg in consumer:
... print (msg)
>>> # join a consumer group for dynamic partition assignment and offset commits
>>> from kafka3 import KafkaConsumer
>>> consumer = KafkaConsumer('my_favorite_topic', group_id='my_favorite_group')
>>> for msg in consumer:
... print (msg)
>>> # manually assign the partition list for the consumer
>>> from kafka3 import TopicPartition
>>> consumer = KafkaConsumer(bootstrap_servers='localhost:1234')
>>> consumer.assign([TopicPartition('foobar', 2)])
>>> msg = next(consumer)
>>> # Deserialize msgpack-encoded values
>>> consumer = KafkaConsumer(value_deserializer=msgpack.loads)
>>> consumer.subscribe(['msgpackfoo'])
>>> for msg in consumer:
... assert isinstance(msg.value, dict)
>>> # Access record headers. The returned value is a list of tuples
>>> # with str, bytes for key and value
>>> for msg in consumer:
... print (msg.headers)
>>> # Get consumer metrics
>>> metrics = consumer.metrics()
KafkaProducer
*************
KafkaProducer is a high-level, asynchronous message producer. The class is
intended to operate as similarly as possible to the official java client.
See <https://kafka-python.readthedocs.io/en/master/apidoc/KafkaProducer.html>
for more details.
>>> from kafka3 import KafkaProducer
>>> producer = KafkaProducer(bootstrap_servers='localhost:1234')
>>> for _ in range(100):
... producer.send('foobar', b'some_message_bytes')
>>> # Block until a single message is sent (or timeout)
>>> future = producer.send('foobar', b'another_message')
>>> result = future.get(timeout=60)
>>> # Block until all pending messages are at least put on the network
>>> # NOTE: This does not guarantee delivery or success! It is really
>>> # only useful if you configure internal batching using linger_ms
>>> producer.flush()
>>> # Use a key for hashed-partitioning
>>> producer.send('foobar', key=b'foo', value=b'bar')
>>> # Serialize json messages
>>> import json
>>> producer = KafkaProducer(value_serializer=lambda v: json.dumps(v).encode('utf-8'))
>>> producer.send('fizzbuzz', {'foo': 'bar'})
>>> # Serialize string keys
>>> producer = KafkaProducer(key_serializer=str.encode)
>>> producer.send('flipflap', key='ping', value=b'1234')
>>> # Compress messages
>>> producer = KafkaProducer(compression_type='gzip')
>>> for i in range(1000):
... producer.send('foobar', b'msg %d' % i)
>>> # Include record headers. The format is list of tuples with string key
>>> # and bytes value.
>>> producer.send('foobar', value=b'c29tZSB2YWx1ZQ==', headers=[('content-encoding', b'base64')])
>>> # Get producer performance metrics
>>> metrics = producer.metrics()
Thread safety
*************
The KafkaProducer can be used across threads without issue, unlike the
KafkaConsumer which cannot.
While it is possible to use the KafkaConsumer in a thread-local manner,
multiprocessing is recommended.
Compression
***********
kafka-python supports the following compression formats:
- gzip
- LZ4
- Snappy
- Zstandard (zstd)
gzip is supported natively, the others require installing additional libraries.
See <https://kafka-python.readthedocs.io/en/master/install.html> for more information.
Optimized CRC32 Validation
**************************
Kafka uses CRC32 checksums to validate messages. kafka-python includes a pure
python implementation for compatibility. To improve performance for high-throughput
applications, kafka-python will use `crc32c` for optimized native code if installed.
See <https://kafka-python.readthedocs.io/en/master/install.html> for installation instructions.
See https://pypi.org/project/crc32c/ for details on the underlying crc32c lib.
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 2.6+).
Raw data
{
"_id": null,
"home_page": "https://github.com/dpkp/kafka-python",
"name": "kafka-python3",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "apache kafka",
"author": "Dana Powers",
"author_email": "dana.powers@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/1a/b8/007e83889d65bcb78a72571a16b3ec09d19e3a684f96747387e693ce16af/kafka-python3-3.0.0.tar.gz",
"platform": null,
"description": "Kafka Python client\n------------------------\n\n.. image:: https://img.shields.io/badge/kafka-2.6%2C%202.5%2C%202.4%2C%202.3%2C%202.2%2C%202.1%2C%202.0%2C%201.1%2C%201.0%2C%200.11%2C%200.10%2C%200.9%2C%200.8-brightgreen.svg\n :target: https://kafka-python.readthedocs.io/en/master/compatibility.html\n.. image:: https://img.shields.io/pypi/pyversions/kafka-python.svg\n :target: https://pypi.python.org/pypi/kafka-python\n.. image:: https://coveralls.io/repos/dpkp/kafka-python/badge.svg?branch=master&service=github\n :target: https://coveralls.io/github/dpkp/kafka-python?branch=master\n.. image:: https://travis-ci.org/dpkp/kafka-python.svg?branch=master\n :target: https://travis-ci.org/dpkp/kafka-python\n.. image:: https://img.shields.io/badge/license-Apache%202-blue.svg\n :target: https://github.com/dpkp/kafka-python/blob/master/LICENSE\n\nPython client for the Apache Kafka distributed stream processing system.\nkafka-python is designed to function much like the official java client, with a\nsprinkling of pythonic interfaces (e.g., consumer iterators).\n\nkafka-python is best used with newer brokers (0.9+), but is backwards-compatible with\nolder versions (to 0.8.0). Some features will only be enabled on newer brokers.\nFor example, fully coordinated consumer groups -- i.e., dynamic partition\nassignment to multiple consumers in the same group -- requires use of 0.9+ kafka\nbrokers. Supporting this feature for earlier broker releases would require\nwriting and maintaining custom leadership election and membership / health\ncheck code (perhaps using zookeeper or consul). For older brokers, you can\nachieve something similar by manually assigning different partitions to each\nconsumer instance with config management tools like chef, ansible, etc. This\napproach will work fine, though it does not support rebalancing on failures.\nSee <https://kafka-python.readthedocs.io/en/master/compatibility.html>\nfor more details.\n\nPlease note that the master branch may contain unreleased features. For release\ndocumentation, please see readthedocs and/or python's inline help.\n\n>>> pip install kafka-python\n\n\nKafkaConsumer\n*************\n\nKafkaConsumer is a high-level message consumer, intended to operate as similarly\nas possible to the official java client. Full support for coordinated\nconsumer groups requires use of kafka brokers that support the Group APIs: kafka v0.9+.\n\nSee <https://kafka-python.readthedocs.io/en/master/apidoc/KafkaConsumer.html>\nfor API and configuration details.\n\nThe consumer iterator returns ConsumerRecords, which are simple namedtuples\nthat expose basic message attributes: topic, partition, offset, key, and value:\n\n>>> from kafka3 import KafkaConsumer\n>>> consumer = KafkaConsumer('my_favorite_topic')\n>>> for msg in consumer:\n... print (msg)\n\n>>> # join a consumer group for dynamic partition assignment and offset commits\n>>> from kafka3 import KafkaConsumer\n>>> consumer = KafkaConsumer('my_favorite_topic', group_id='my_favorite_group')\n>>> for msg in consumer:\n... print (msg)\n\n>>> # manually assign the partition list for the consumer\n>>> from kafka3 import TopicPartition\n>>> consumer = KafkaConsumer(bootstrap_servers='localhost:1234')\n>>> consumer.assign([TopicPartition('foobar', 2)])\n>>> msg = next(consumer)\n\n>>> # Deserialize msgpack-encoded values\n>>> consumer = KafkaConsumer(value_deserializer=msgpack.loads)\n>>> consumer.subscribe(['msgpackfoo'])\n>>> for msg in consumer:\n... assert isinstance(msg.value, dict)\n\n>>> # Access record headers. The returned value is a list of tuples\n>>> # with str, bytes for key and value\n>>> for msg in consumer:\n... print (msg.headers)\n\n>>> # Get consumer metrics\n>>> metrics = consumer.metrics()\n\n\nKafkaProducer\n*************\n\nKafkaProducer is a high-level, asynchronous message producer. The class is\nintended to operate as similarly as possible to the official java client.\nSee <https://kafka-python.readthedocs.io/en/master/apidoc/KafkaProducer.html>\nfor more details.\n\n>>> from kafka3 import KafkaProducer\n>>> producer = KafkaProducer(bootstrap_servers='localhost:1234')\n>>> for _ in range(100):\n... producer.send('foobar', b'some_message_bytes')\n\n>>> # Block until a single message is sent (or timeout)\n>>> future = producer.send('foobar', b'another_message')\n>>> result = future.get(timeout=60)\n\n>>> # Block until all pending messages are at least put on the network\n>>> # NOTE: This does not guarantee delivery or success! It is really\n>>> # only useful if you configure internal batching using linger_ms\n>>> producer.flush()\n\n>>> # Use a key for hashed-partitioning\n>>> producer.send('foobar', key=b'foo', value=b'bar')\n\n>>> # Serialize json messages\n>>> import json\n>>> producer = KafkaProducer(value_serializer=lambda v: json.dumps(v).encode('utf-8'))\n>>> producer.send('fizzbuzz', {'foo': 'bar'})\n\n>>> # Serialize string keys\n>>> producer = KafkaProducer(key_serializer=str.encode)\n>>> producer.send('flipflap', key='ping', value=b'1234')\n\n>>> # Compress messages\n>>> producer = KafkaProducer(compression_type='gzip')\n>>> for i in range(1000):\n... producer.send('foobar', b'msg %d' % i)\n\n>>> # Include record headers. The format is list of tuples with string key\n>>> # and bytes value.\n>>> producer.send('foobar', value=b'c29tZSB2YWx1ZQ==', headers=[('content-encoding', b'base64')])\n\n>>> # Get producer performance metrics\n>>> metrics = producer.metrics()\n\n\nThread safety\n*************\n\nThe KafkaProducer can be used across threads without issue, unlike the\nKafkaConsumer which cannot.\n\nWhile it is possible to use the KafkaConsumer in a thread-local manner,\nmultiprocessing is recommended.\n\n\nCompression\n***********\n\nkafka-python supports the following compression formats:\n\n- gzip\n- LZ4\n- Snappy\n- Zstandard (zstd)\n\ngzip is supported natively, the others require installing additional libraries.\nSee <https://kafka-python.readthedocs.io/en/master/install.html> for more information.\n\n\nOptimized CRC32 Validation\n**************************\n\nKafka uses CRC32 checksums to validate messages. kafka-python includes a pure\npython implementation for compatibility. To improve performance for high-throughput\napplications, kafka-python will use `crc32c` for optimized native code if installed.\nSee <https://kafka-python.readthedocs.io/en/master/install.html> for installation instructions.\nSee https://pypi.org/project/crc32c/ for details on the underlying crc32c lib.\n\n\nProtocol\n********\n\nA secondary goal of kafka-python is to provide an easy-to-use protocol layer\nfor interacting with kafka brokers via the python repl. This is useful for\ntesting, probing, and general experimentation. The protocol support is\nleveraged to enable a KafkaClient.check_version() method that\nprobes a kafka broker and attempts to identify which version it is running\n(0.8.0 to 2.6+).",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Pure Python client for Apache Kafka",
"version": "3.0.0",
"project_urls": {
"Homepage": "https://github.com/dpkp/kafka-python"
},
"split_keywords": [
"apache",
"kafka"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1ab8007e83889d65bcb78a72571a16b3ec09d19e3a684f96747387e693ce16af",
"md5": "fad7140b4294ad98d5b74c17477a0ef0",
"sha256": "01b911bb5402a7c4f9af3ea382bb060e9aa487b5dec249cf5e798c6e9822a62f"
},
"downloads": -1,
"filename": "kafka-python3-3.0.0.tar.gz",
"has_sig": false,
"md5_digest": "fad7140b4294ad98d5b74c17477a0ef0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 271390,
"upload_time": "2022-05-20T07:11:03",
"upload_time_iso_8601": "2022-05-20T07:11:03.671393Z",
"url": "https://files.pythonhosted.org/packages/1a/b8/007e83889d65bcb78a72571a16b3ec09d19e3a684f96747387e693ce16af/kafka-python3-3.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-05-20 07:11:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dpkp",
"github_project": "kafka-python",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "kafka-python3"
}
JSON
