Skip to content

Commit f2985e5

Browse files
author
Matt Howlett
committed
A bit of README.md polish (#1424)
* A bit of README.md polish * additional tweaks * updates based on review feedback
1 parent d0e1da7 commit f2985e5

File tree

1 file changed

+21
-23
lines changed

1 file changed

+21
-23
lines changed

README.md

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Confluent's Python Client for Apache Kafka<sup>TM</sup>
33

44
**confluent-kafka-python** provides a high-level Producer, Consumer and AdminClient compatible with all
55
[Apache Kafka<sup>TM<sup>](http://kafka.apache.org/) brokers >= v0.8, [Confluent Cloud](https://www.confluent.io/confluent-cloud/)
6-
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:
77

88
- **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).
99

@@ -15,18 +15,21 @@ with Apache Kafka at its core. It's high priority for us that client features ke
1515
pace with core Apache Kafka and components of the [Confluent Platform](https://www.confluent.io/product/compare/).
1616

1717

18-
See the [API documentation](http://docs.confluent.io/current/clients/confluent-kafka-python/index.html) for more info.
18+
## Usage
1919

2020
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/).
2121

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.
26+
- [Confluent Cloud](https://www.confluent.io/confluent-cloud/) configuration.
2227

23-
Usage
24-
=====
28+
Also refer to the [API documentation](http://docs.confluent.io/current/clients/confluent-kafka-python/index.html).
2529

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.
2731

28-
29-
**Producer**
32+
### Basic Producer Example
3033

3134
```python
3235
from confluent_kafka import Producer
@@ -60,7 +63,7 @@ For a discussion on the poll based producer API, refer to the
6063
blog post.
6164

6265

63-
**Consumer**
66+
### Basic Consumer Example
6467

6568
```python
6669
from confluent_kafka import Consumer
@@ -88,7 +91,7 @@ c.close()
8891
```
8992

9093

91-
**AdminClient**
94+
### Basic AdminClient Example
9295

9396
Create topics:
9497

@@ -114,14 +117,12 @@ for topic, f in fs.items():
114117
```
115118

116119

117-
Thread Safety
118-
-------------
120+
## Thread Safety
119121

120122
The `Producer`, `Consumer` and `AdminClient` are all thread safe.
121123

122124

123-
Install
124-
=======
125+
## Install
125126

126127
**Install self-contained binary wheels**
127128

@@ -138,8 +139,8 @@ Install
138139
For source install, see the *Install from source* section in [INSTALL.md](INSTALL.md).
139140

140141

141-
Broker Compatibility
142-
====================
142+
## Broker Compatibility
143+
143144
The Python client (as well as the underlying C library librdkafka) supports
144145
all broker versions &gt;= 0.8.
145146
But due to the nature of the Kafka protocol in broker versions 0.8 and 0.9 it
@@ -161,8 +162,8 @@ More info here:
161162
https://github.com/edenhill/librdkafka/wiki/Broker-version-compatibility
162163

163164

164-
SSL certificates
165-
================
165+
## SSL certificates
166+
166167
If you're connecting to a Kafka cluster through SSL you will need to configure
167168
the client with `'security.protocol': 'SSL'` (or `'SASL_SSL'` if SASL
168169
authentication is used).
@@ -181,8 +182,7 @@ Python package. To use certifi, add an `import certifi` line and configure the
181182
client's CA location with `'ssl.ca.location': certifi.where()`.
182183

183184

184-
License
185-
=======
185+
## License
186186

187187
[Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0)
188188

@@ -191,13 +191,11 @@ by confluent-kafka-python. confluent-kafka-python has no affiliation with and is
191191
The Apache Software Foundation.
192192

193193

194-
Developer Notes
195-
===============
194+
## Developer Notes
196195

197196
Instructions on building and testing confluent-kafka-python can be found [here](DEVELOPER.md).
198197

199198

200-
Confluent Cloud
201-
===============
199+
## Confluent Cloud
202200

203201
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

Comments
 (0)