Skip to content

Commit 7b3b73e

Browse files
committed
Doc updates for compatibility
1 parent d613173 commit 7b3b73e

File tree

4 files changed

+10
-12
lines changed

4 files changed

+10
-12
lines changed

docs/compatibility.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Although kafka-python is tested and expected to work on recent broker versions,
1616
not all features are supported. Please see github open issues for feature tracking.
1717
PRs welcome!
1818

19-
kafka-python is tested on python 2.7, and 3.8-3.13.
19+
kafka-python is tested on python 3.8-3.14.
20+
python 2.7 was supported through kafka-python release 2.3.
2021

2122
Builds and tests via Github Actions Workflows. See https://github.com/dpkp/kafka-python/actions

kafka/admin/client.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,8 +119,7 @@ class KafkaAdminClient(object):
119119
ssl_crlfile (str): Optional filename containing the CRL to check for
120120
certificate expiration. By default, no CRL check is done. When
121121
providing a file, only the leaf certificate will be checked against
122-
this CRL. The CRL can only be checked with Python 3.4+ or 2.7.9+.
123-
Default: None.
122+
this CRL. Default: None.
124123
api_version (tuple): Specify which Kafka API version to use. If set
125124
to None, KafkaClient will attempt to infer the broker version by
126125
probing various APIs. Example: (0, 10, 2). Default: None

kafka/consumer/group.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -201,8 +201,7 @@ class KafkaConsumer(object):
201201
ssl_crlfile (str): Optional filename containing the CRL to check for
202202
certificate expiration. By default, no CRL check is done. When
203203
providing a file, only the leaf certificate will be checked against
204-
this CRL. The CRL can only be checked with Python 3.4+ or 2.7.9+.
205-
Default: None.
204+
this CRL. Default: None.
206205
ssl_ciphers (str): optionally set the available ciphers for ssl
207206
connections. It should be a string in the OpenSSL cipher list
208207
format. If no cipher can be selected (because compile-time options

kafka/producer/kafka.py

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -292,21 +292,20 @@ class KafkaProducer(object):
292292
will be ignored. Default: None.
293293
ssl_check_hostname (bool): flag to configure whether ssl handshake
294294
should verify that the certificate matches the brokers hostname.
295-
default: true.
295+
Default: True.
296296
ssl_cafile (str): optional filename of ca file to use in certificate
297-
verification. default: none.
297+
verification. Default: None.
298298
ssl_certfile (str): optional filename of file in pem format containing
299299
the client certificate, as well as any ca certificates needed to
300-
establish the certificate's authenticity. default: none.
300+
establish the certificate's authenticity. Default: None.
301301
ssl_keyfile (str): optional filename containing the client private key.
302-
default: none.
302+
Default: None.
303303
ssl_password (str): optional password to be used when loading the
304-
certificate chain. default: none.
304+
certificate chain. Default: None.
305305
ssl_crlfile (str): optional filename containing the CRL to check for
306306
certificate expiration. By default, no CRL check is done. When
307307
providing a file, only the leaf certificate will be checked against
308-
this CRL. The CRL can only be checked with Python 3.4+ or 2.7.9+.
309-
default: none.
308+
this CRL. Default: None.
310309
ssl_ciphers (str): optionally set the available ciphers for ssl
311310
connections. It should be a string in the OpenSSL cipher list
312311
format. If no cipher can be selected (because compile-time options

0 commit comments

Comments
 (0)