Skip to content

Commit 2a5a1b1

Browse files
committed
Restructure README
1 parent 64ee775 commit 2a5a1b1

File tree

1 file changed

+37
-34
lines changed

1 file changed

+37
-34
lines changed

README.md

Lines changed: 37 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -111,26 +111,27 @@ c.close()
111111
See [examples](examples) for more examples.
112112

113113

114-
Broker Compatibility
115-
====================
116-
The Python client (as well as the underlying C library librdkafka) supports
117-
all broker versions >= 0.8.
118-
But due to the nature of the Kafka protocol in broker versions 0.8 and 0.9 it
119-
is not safe for a client to assume what protocol version is actually supported
120-
by the broker, thus you will need to hint the Python client what protocol
121-
version it may use. This is done through two configuration settings:
114+
Install
115+
=======
122116

123-
* `broker.version.fallback=YOUR_BROKER_VERSION` (default 0.9.0.1)
124-
* `api.version.request=true|false` (default true)
117+
**Install self-contained binary wheels for OSX and Linux from PyPi:**
125118

126-
When using a Kafka 0.10 broker or later you don't need to do anything
127-
(`api.version.request=true` is the default).
128-
If you use Kafka broker 0.9 or 0.8 you must set `api.version.request=false`
129-
and set `broker.version.fallback` to your broker version,
130-
e.g `broker.version.fallback=0.9.0.1`.
119+
$ pip install confluent-kafka
131120

132-
More info here:
133-
https://github.com/edenhill/librdkafka/wiki/Broker-version-compatibility
121+
**Install AvroProducer and AvroConsumer:**
122+
123+
$ pip install confluent-kafka[avro]
124+
125+
**Install from source from PyPi** *(requires librdkafka + dependencies to be installed separately)*:
126+
127+
$ pip install --no-binary :all: confluent-kafka
128+
129+
**Install from source directory:**
130+
131+
$ pip install .
132+
133+
# for AvroProducer or AvroConsumer
134+
$ pip install .[avro]
134135

135136

136137
Prerequisites
@@ -139,7 +140,7 @@ Prerequisites
139140
* Python >= 2.7 or Python 3.x
140141
* ([librdkafka](https://github.com/edenhill/librdkafka) >= 0.9.2)
141142

142-
The latest version of librdkafka is embedded in the OSX and manylinux wheels,
143+
The latest version of librdkafka is embedded in the OSX and Linux wheels,
143144
for other platforms or when a specific version of librdkafka is desired, follow these guidelines:
144145

145146
* For **Debian/Ubuntu** based systems, add the Confluent APT repository and then do `sudo apt-get install librdkafka-dev python-dev`:
@@ -150,30 +151,32 @@ http://docs.confluent.io/current/installation.html#rpm-packages-via-yum
150151

151152
* On **OSX**, use **homebrew** and do `sudo brew install librdkafka`
152153

153-
**NOTE:** The pre-built manylinux wheels do NOT contain SASL Kerberos support. If you need SASL Kerberos support you must install librdkafka and its dependencies using the above repositories and then build confluent-kafka from source using the instructions below.
154+
**NOTE:** The pre-built Linux wheels do NOT contain SASL Kerberos support. If you need SASL Kerberos support you must install librdkafka and its dependencies using the above repositories and then build confluent-kafka from source using the instructions below.
154155

155156

156-
Install
157-
=======
158-
159-
**Install self-contained binary wheels for OSX and Linux from PyPi:**
160-
161-
$ pip install confluent-kafka
162-
163-
**Install AvroProducer and AvroConsumer:**
164157

165-
$ pip install confluent-kafka[avro]
158+
Broker Compatibility
159+
====================
160+
The Python client (as well as the underlying C library librdkafka) supports
161+
all broker versions >= 0.8.
162+
But due to the nature of the Kafka protocol in broker versions 0.8 and 0.9 it
163+
is not safe for a client to assume what protocol version is actually supported
164+
by the broker, thus you will need to hint the Python client what protocol
165+
version it may use. This is done through two configuration settings:
166166

167-
**Install from source from PyPi** *(requires librdkafka + dependencies to be installed separately)*:
167+
* `broker.version.fallback=YOUR_BROKER_VERSION` (default 0.9.0.1)
168+
* `api.version.request=true|false` (default true)
168169

169-
$ pip install --no-binary :all: confluent-kafka
170+
When using a Kafka 0.10 broker or later you don't need to do anything
171+
(`api.version.request=true` is the default).
172+
If you use Kafka broker 0.9 or 0.8 you must set `api.version.request=false`
173+
and set `broker.version.fallback` to your broker version,
174+
e.g `broker.version.fallback=0.9.0.1`.
170175

171-
**Install from source directory:**
176+
More info here:
177+
https://github.com/edenhill/librdkafka/wiki/Broker-version-compatibility
172178

173-
$ pip install .
174179

175-
# for AvroProducer or AvroConsumer
176-
$ pip install .[avro]
177180

178181

179182
Build

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy