You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
and the [Confluent Platform](https://www.confluent.io/product/compare/). The client is:
6
+
and [Confluent Platform](https://www.confluent.io/product/compare/). The client is:
7
7
8
8
-**Reliable** - It's a wrapper around [librdkafka](https://github.com/edenhill/librdkafka) (provided automatically via binary wheels) which is widely deployed in a diverse set of production scenarios. It's tested using [the same set of system tests](https://github.com/confluentinc/confluent-kafka-python/tree/master/src/confluent_kafka/kafkatest) as the Java client [and more](https://github.com/confluentinc/confluent-kafka-python/tree/master/tests). It's supported by [Confluent](https://confluent.io).
9
9
@@ -15,18 +15,21 @@ with Apache Kafka at its core. It's high priority for us that client features ke
15
15
pace with core Apache Kafka and components of the [Confluent Platform](https://www.confluent.io/product/compare/).
16
16
17
17
18
-
See the [API documentation](http://docs.confluent.io/current/clients/confluent-kafka-python/index.html) for more info.
18
+
## Usage
19
19
20
20
For a step-by-step guide on using the client see [Getting Started with Apache Kafka and Python](https://developer.confluent.io/get-started/python/).
21
21
22
+
Aditional examples can be found in the [examples](examples) directory or the [confluentinc/examples](https://github.com/confluentinc/examples/tree/master/clients/cloud/python) github repo, which include demonstration of:
23
+
- Exactly once data processing using the transactional API.
24
+
- Integration with asyncio.
25
+
- (De)serializing Protobuf, JSON, and Avro data with Confluent Schema Registry integration.
Also refer to the [API documentation](http://docs.confluent.io/current/clients/confluent-kafka-python/index.html).
25
29
26
-
Below are some examples of typical usage. For more examples, see the [examples](examples) directory or the [confluentinc/examples](https://github.com/confluentinc/examples/tree/master/clients/cloud/python) github repo for a [Confluent Cloud](https://www.confluent.io/confluent-cloud/)example. In particular, (de)serializers for Protobuf, JSON, and Avro with Confluent Schema Registry integration are now provided out-of-the-box.
30
+
Finally, the [tests](tests) are useful as a reference for example usage.
27
31
28
-
29
-
**Producer**
32
+
### Basic Producer Example
30
33
31
34
```python
32
35
from confluent_kafka import Producer
@@ -60,7 +63,7 @@ For a discussion on the poll based producer API, refer to the
60
63
blog post.
61
64
62
65
63
-
**Consumer**
66
+
### Basic Consumer Example
64
67
65
68
```python
66
69
from confluent_kafka import Consumer
@@ -88,7 +91,7 @@ c.close()
88
91
```
89
92
90
93
91
-
**AdminClient**
94
+
### Basic AdminClient Example
92
95
93
96
Create topics:
94
97
@@ -114,14 +117,12 @@ for topic, f in fs.items():
114
117
```
115
118
116
119
117
-
Thread Safety
118
-
-------------
120
+
## Thread Safety
119
121
120
122
The `Producer`, `Consumer` and `AdminClient` are all thread safe.
121
123
122
124
123
-
Install
124
-
=======
125
+
## Install
125
126
126
127
**Install self-contained binary wheels**
127
128
@@ -138,8 +139,8 @@ Install
138
139
For source install, see the *Install from source* section in [INSTALL.md](INSTALL.md).
139
140
140
141
141
-
Broker Compatibility
142
-
====================
142
+
## Broker Compatibility
143
+
143
144
The Python client (as well as the underlying C library librdkafka) supports
144
145
all broker versions >= 0.8.
145
146
But due to the nature of the Kafka protocol in broker versions 0.8 and 0.9 it
@@ -191,13 +191,11 @@ by confluent-kafka-python. confluent-kafka-python has no affiliation with and is
191
191
The Apache Software Foundation.
192
192
193
193
194
-
Developer Notes
195
-
===============
194
+
## Developer Notes
196
195
197
196
Instructions on building and testing confluent-kafka-python can be found [here](DEVELOPER.md).
198
197
199
198
200
-
Confluent Cloud
201
-
===============
199
+
## Confluent Cloud
202
200
203
201
For a step-by-step guide on using the Python client with Confluent Cloud see [Getting Started with Apache Kafka and Python](https://developer.confluent.io/get-started/python/) on [Confluent Developer](https://developer.confluent.io/).
0 commit comments