Skip to content

Commit c13bdca

Browse files
wbarnhabradenneal1
wbarnha
authored and
bradenneal1
committed
Rename project from kafka-python to kafka-python-ng (dpkp#1)
1 parent b66f7e5 commit c13bdca

File tree

15 files changed

+84
-75
lines changed

15 files changed

+84
-75
lines changed

‎CHANGES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -413,7 +413,7 @@ Some of the major changes include:
413413
* SASL authentication is working (we think)
414414
* Removed several circular references to improve gc on close()
415415

416-
Thanks to all contributors -- the state of the kafka-python community is strong!
416+
Thanks to all contributors -- the state of the kafka-python-ng community is strong!
417417

418418
Detailed changelog are listed below:
419419

‎Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ cov-local: build-integration
3333
@echo "open file://`pwd`/htmlcov/index.html"
3434

3535
# Check the readme for syntax errors, which can lead to invalid formatting on
36-
# PyPi homepage (https://pypi.python.org/pypi/kafka-python)
36+
# PyPi homepage (https://pypi.python.org/pypi/kafka-python-ng)
3737
check-readme:
3838
python setup.py check -rms
3939

‎README.rst

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,27 @@ Kafka Python client
22
------------------------
33

44
.. 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
5-
:target: https://kafka-python.readthedocs.io/en/master/compatibility.html
6-
.. image:: https://img.shields.io/pypi/pyversions/kafka-python.svg
7-
:target: https://pypi.python.org/pypi/kafka-python
8-
.. image:: https://coveralls.io/repos/dpkp/kafka-python/badge.svg?branch=master&service=github
9-
:target: https://coveralls.io/github/dpkp/kafka-python?branch=master
5+
:target: https://kafka-python-ng.readthedocs.io/en/master/compatibility.html
6+
.. image:: https://img.shields.io/pypi/pyversions/kafka-python-ng.svg
7+
:target: https://pypi.python.org/pypi/kafka-python-ng
8+
.. image:: https://coveralls.io/repos/wbarnha/kafka-python-ng-ng/badge.svg?branch=master&service=github
9+
:target: https://coveralls.io/github/wbarnha/kafka-python-ng-ng?branch=master
1010
.. image:: https://img.shields.io/badge/license-Apache%202-blue.svg
11-
:target: https://github.com/dpkp/kafka-python/blob/master/LICENSE
12-
.. image:: https://img.shields.io/pypi/dw/kafka-python.svg
11+
:target: https://github.com/wbarnha/kafka-python-ng-ng/blob/master/LICENSE
12+
.. image:: https://img.shields.io/pypi/dw/kafka-python-ng.svg
1313
:target: https://pypistats.org/packages/kafka-python
1414
.. image:: https://img.shields.io/pypi/v/kafka-python.svg
1515
:target: https://pypi.org/project/kafka-python
1616
.. image:: https://img.shields.io/pypi/implementation/kafka-python
17-
:target: https://github.com/dpkp/kafka-python/blob/master/setup.py
17+
:target: https://github.com/wbarnha/kafka-python-ng/blob/master/setup.py
1818

1919

2020

2121
Python client for the Apache Kafka distributed stream processing system.
22-
kafka-python is designed to function much like the official java client, with a
22+
kafka-python-ng is designed to function much like the official java client, with a
2323
sprinkling of pythonic interfaces (e.g., consumer iterators).
2424

25-
kafka-python is best used with newer brokers (0.9+), but is backwards-compatible with
25+
kafka-python-ng is best used with newer brokers (0.9+), but is backwards-compatible with
2626
older versions (to 0.8.0). Some features will only be enabled on newer brokers.
2727
For example, fully coordinated consumer groups -- i.e., dynamic partition
2828
assignment to multiple consumers in the same group -- requires use of 0.9+ kafka
@@ -32,13 +32,13 @@ check code (perhaps using zookeeper or consul). For older brokers, you can
3232
achieve something similar by manually assigning different partitions to each
3333
consumer instance with config management tools like chef, ansible, etc. This
3434
approach will work fine, though it does not support rebalancing on failures.
35-
See <https://kafka-python.readthedocs.io/en/master/compatibility.html>
35+
See <https://kafka-python-ng.readthedocs.io/en/master/compatibility.html>
3636
for more details.
3737

3838
Please note that the master branch may contain unreleased features. For release
3939
documentation, please see readthedocs and/or python's inline help.
4040

41-
>>> pip install kafka-python
41+
>>> pip install kafka-python-ng
4242

4343

4444
KafkaConsumer
@@ -48,7 +48,7 @@ KafkaConsumer is a high-level message consumer, intended to operate as similarly
4848
as possible to the official java client. Full support for coordinated
4949
consumer groups requires use of kafka brokers that support the Group APIs: kafka v0.9+.
5050

51-
See <https://kafka-python.readthedocs.io/en/master/apidoc/KafkaConsumer.html>
51+
See <https://kafka-python-ng.readthedocs.io/en/master/apidoc/KafkaConsumer.html>
5252
for API and configuration details.
5353

5454
The consumer iterator returns ConsumerRecords, which are simple namedtuples
@@ -91,7 +91,7 @@ KafkaProducer
9191

9292
KafkaProducer is a high-level, asynchronous message producer. The class is
9393
intended to operate as similarly as possible to the official java client.
94-
See <https://kafka-python.readthedocs.io/en/master/apidoc/KafkaProducer.html>
94+
See <https://kafka-python-ng.readthedocs.io/en/master/apidoc/KafkaProducer.html>
9595
for more details.
9696

9797
>>> from kafka import KafkaProducer
@@ -146,31 +146,31 @@ multiprocessing is recommended.
146146
Compression
147147
***********
148148

149-
kafka-python supports the following compression formats:
149+
kafka-python-ng supports the following compression formats:
150150

151151
- gzip
152152
- LZ4
153153
- Snappy
154154
- Zstandard (zstd)
155155

156156
gzip is supported natively, the others require installing additional libraries.
157-
See <https://kafka-python.readthedocs.io/en/master/install.html> for more information.
157+
See <https://kafka-python-ng.readthedocs.io/en/master/install.html> for more information.
158158

159159

160160
Optimized CRC32 Validation
161161
**************************
162162

163-
Kafka uses CRC32 checksums to validate messages. kafka-python includes a pure
163+
Kafka uses CRC32 checksums to validate messages. kafka-python-ng includes a pure
164164
python implementation for compatibility. To improve performance for high-throughput
165-
applications, kafka-python will use `crc32c` for optimized native code if installed.
166-
See <https://kafka-python.readthedocs.io/en/master/install.html> for installation instructions.
165+
applications, kafka-python-ng will use `crc32c` for optimized native code if installed.
166+
See <https://kafka-python-ng.readthedocs.io/en/master/install.html> for installation instructions.
167167
See https://pypi.org/project/crc32c/ for details on the underlying crc32c lib.
168168

169169

170170
Protocol
171171
********
172172

173-
A secondary goal of kafka-python is to provide an easy-to-use protocol layer
173+
A secondary goal of kafka-python-ng is to provide an easy-to-use protocol layer
174174
for interacting with kafka brokers via the python repl. This is useful for
175175
testing, probing, and general experimentation. The protocol support is
176176
leveraged to enable a KafkaClient.check_version() method that

‎docs/Makefile

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -85,17 +85,17 @@ qthelp:
8585
@echo
8686
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
8787
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
88-
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/kafka-python.qhcp"
88+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/kafka-python-ng.qhcp"
8989
@echo "To view the help file:"
90-
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/kafka-python.qhc"
90+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/kafka-python-ng.qhc"
9191

9292
devhelp:
9393
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
9494
@echo
9595
@echo "Build finished."
9696
@echo "To view the help file:"
97-
@echo "# mkdir -p $$HOME/.local/share/devhelp/kafka-python"
98-
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/kafka-python"
97+
@echo "# mkdir -p $$HOME/.local/share/devhelp/kafka-python-ng"
98+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/kafka-python-ng"
9999
@echo "# devhelp"
100100

101101
epub:

‎docs/apidoc/modules.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
kafka-python API
1+
kafka-python-ng API
22
****************
33

44
.. toctree::

‎docs/changelog.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -484,7 +484,7 @@ Some of the major changes include:
484484
* SASL authentication is working (we think)
485485
* Removed several circular references to improve gc on close()
486486

487-
Thanks to all contributors -- the state of the kafka-python community is strong!
487+
Thanks to all contributors -- the state of the kafka-python-ng community is strong!
488488

489489
Detailed changelog are listed below:
490490

‎docs/compatibility.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,20 @@ Compatibility
22
-------------
33

44
.. 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
5-
:target: https://kafka-python.readthedocs.io/compatibility.html
6-
.. image:: https://img.shields.io/pypi/pyversions/kafka-python.svg
7-
:target: https://pypi.python.org/pypi/kafka-python
5+
:target: https://kafka-python-ng.readthedocs.io/compatibility.html
6+
.. image:: https://img.shields.io/pypi/pyversions/kafka-python-ng.svg
7+
:target: https://pypi.python.org/pypi/kafka-python-ng
88

9-
kafka-python is compatible with (and tested against) broker versions 2.6
10-
through 0.8.0 . kafka-python is not compatible with the 0.8.2-beta release.
9+
kafka-python-ng is compatible with (and tested against) broker versions 2.6
10+
through 0.8.0 . kafka-python-ng is not compatible with the 0.8.2-beta release.
1111

12-
Because the kafka server protocol is backwards compatible, kafka-python is
12+
Because the kafka server protocol is backwards compatible, kafka-python-ng is
1313
expected to work with newer broker releases as well.
1414

15-
Although kafka-python is tested and expected to work on recent broker versions,
15+
Although kafka-python-ng is tested and expected to work on recent broker versions,
1616
not all features are supported. Specifically, authentication codecs, and
1717
transactional producer/consumer support are not fully implemented. PRs welcome!
1818

19-
kafka-python is tested on python 2.7, 3.4, 3.7, 3.8 and pypy2.7.
19+
kafka-python-ng is tested on python 2.7, 3.4, 3.7, 3.8 and pypy2.7.
2020

21-
Builds and tests via Travis-CI. See https://travis-ci.org/dpkp/kafka-python
21+
Builds and tests via Travis-CI. See https://travis-ci.org/wbarnha/kafka-python-ng

‎docs/conf.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# -*- coding: utf-8 -*-
22
#
3-
# kafka-python documentation build configuration file, created by
3+
# kafka-python-ng documentation build configuration file, created by
44
# sphinx-quickstart on Sun Jan 4 12:21:50 2015.
55
#
66
# This file is execfile()d with the current directory set to its
@@ -47,7 +47,7 @@
4747
master_doc = 'index'
4848

4949
# General information about the project.
50-
project = u'kafka-python'
50+
project = u'kafka-python-ng'
5151
copyright = u'2016 -- Dana Powers, David Arthur, and Contributors'
5252

5353
# The version info for the project you're documenting, acts as replacement for
@@ -201,7 +201,7 @@
201201
# (source start file, target name, title,
202202
# author, documentclass [howto, manual, or own class]).
203203
latex_documents = [
204-
('index', 'kafka-python.tex', u'kafka-python Documentation',
204+
('index', 'kafka-python-ng.tex', u'kafka-python-ng Documentation',
205205
u'Dana Powers', 'manual'),
206206
]
207207

@@ -231,7 +231,7 @@
231231
# One entry per manual page. List of tuples
232232
# (source start file, name, description, authors, manual section).
233233
man_pages = [
234-
('index', 'kafka-python', u'kafka-python Documentation',
234+
('index', 'kafka-python-ng', u'kafka-python-ng Documentation',
235235
[u'Dana Powers'], 1)
236236
]
237237

@@ -245,7 +245,7 @@
245245
# (source start file, target name, title, author,
246246
# dir menu entry, description, category)
247247
texinfo_documents = [
248-
('index', 'kafka-python', u'kafka-python Documentation',
248+
('index', 'kafka-python-ng', u'kafka-python-ng Documentation',
249249
u'Dana Powers', 'kafka-python', 'One line description of project.',
250250
'Miscellaneous'),
251251
]

‎docs/index.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
kafka-python
1+
kafka-python-ng
22
############
33

44
.. 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
55
:target: https://kafka-python.readthedocs.io/en/master/compatibility.html
66
.. image:: https://img.shields.io/pypi/pyversions/kafka-python.svg
7-
:target: https://pypi.python.org/pypi/kafka-python
8-
.. image:: https://coveralls.io/repos/dpkp/kafka-python/badge.svg?branch=master&service=github
9-
:target: https://coveralls.io/github/dpkp/kafka-python?branch=master
10-
.. image:: https://travis-ci.org/dpkp/kafka-python.svg?branch=master
11-
:target: https://travis-ci.org/dpkp/kafka-python
7+
:target: https://pypi.python.org/pypi/kafka-python-ng
8+
.. image:: https://coveralls.io/repos/wbarnha/kafka-python-ng/badge.svg?branch=master&service=github
9+
:target: https://coveralls.io/github/wbarnha/kafka-python-ng?branch=master
10+
.. image:: https://travis-ci.org/wbarnha/kafka-python-ng.svg?branch=master
11+
:target: https://travis-ci.org/wbarnha/kafka-python-ng
1212
.. image:: https://img.shields.io/badge/license-Apache%202-blue.svg
13-
:target: https://github.com/dpkp/kafka-python/blob/master/LICENSE
13+
:target: https://github.com/wbarnha/kafka-python-ng/blob/master/LICENSE
1414

1515
Python client for the Apache Kafka distributed stream processing system.
1616
kafka-python is designed to function much like the official java client, with a
@@ -31,7 +31,7 @@ failures. See `Compatibility <compatibility.html>`_ for more details.
3131
Please note that the master branch may contain unreleased features. For release
3232
documentation, please see readthedocs and/or python's inline help.
3333

34-
>>> pip install kafka-python
34+
>>> pip install kafka-python-ng
3535

3636

3737
KafkaConsumer

‎docs/install.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,47 +9,47 @@ Pip:
99

1010
.. code:: bash
1111
12-
pip install kafka-python
12+
pip install kafka-python-ng
1313
14-
Releases are also listed at https://github.com/dpkp/kafka-python/releases
14+
Releases are also listed at https://github.com/wbarnha/kafka-python-ng/releases
1515

1616

1717
Bleeding-Edge
1818
*************
1919

2020
.. code:: bash
2121
22-
git clone https://github.com/dpkp/kafka-python
23-
pip install ./kafka-python
22+
git clone https://github.com/wbarnha/kafka-python-ng
23+
pip install ./kafka-python-ng
2424
2525
2626
Optional crc32c install
2727
***********************
28-
Highly recommended if you are using Kafka 11+ brokers. For those `kafka-python`
28+
Highly recommended if you are using Kafka 11+ brokers. For those `kafka-python-ng`
2929
uses a new message protocol version, that requires calculation of `crc32c`,
30-
which differs from the `zlib.crc32` hash implementation. By default `kafka-python`
30+
which differs from the `zlib.crc32` hash implementation. By default `kafka-python-ng`
3131
calculates it in pure python, which is quite slow. To speed it up we optionally
3232
support https://pypi.python.org/pypi/crc32c package if it's installed.
3333

3434
.. code:: bash
3535
36-
pip install 'kafka-python[crc32c]'
36+
pip install 'kafka-python-ng[crc32c]'
3737
3838
3939
Optional ZSTD install
4040
********************
4141

4242
To enable ZSTD compression/decompression, install python-zstandard:
4343

44-
>>> pip install 'kafka-python[zstd]'
44+
>>> pip install 'kafka-python-ng[zstd]'
4545

4646

4747
Optional LZ4 install
4848
********************
4949

5050
To enable LZ4 compression/decompression, install python-lz4:
5151

52-
>>> pip install 'kafka-python[lz4]'
52+
>>> pip install 'kafka-python-ng[lz4]'
5353

5454

5555
Optional Snappy install
@@ -90,4 +90,4 @@ Install the `python-snappy` module
9090

9191
.. code:: bash
9292
93-
pip install 'kafka-python[snappy]'
93+
pip install 'kafka-python-ng[snappy]'

‎docs/license.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@ License
22
-------
33

44
.. image:: https://img.shields.io/badge/license-Apache%202-blue.svg
5-
:target: https://github.com/dpkp/kafka-python/blob/master/LICENSE
5+
:target: https://github.com/wbarnha/kafka-python-ng/blob/master/LICENSE
66

7-
Apache License, v2.0. See `LICENSE <https://github.com/dpkp/kafka-python/blob/master/LICENSE>`_.
7+
Apache License, v2.0. See `LICENSE <https://github.com/wbarnha/kafka-python-ng/blob/master/LICENSE>`_.
88

99
Copyright 2016, Dana Powers, David Arthur, and Contributors
10-
(See `AUTHORS <https://github.com/dpkp/kafka-python/blob/master/AUTHORS.md>`_).
10+
(See `AUTHORS <https://github.com/wbarnha/kafka-python-ng/blob/master/AUTHORS.md>`_).

‎docs/support.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Support
22
-------
33

4-
For support, see github issues at https://github.com/dpkp/kafka-python
4+
For support, see github issues at https://github.com/wbarnha/kafka-python-ng
55

66
Limited IRC chat at #kafka-python on freenode (general chat is #apache-kafka).
77

‎docs/tests.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
Tests
22
=====
33

4-
.. image:: https://coveralls.io/repos/dpkp/kafka-python/badge.svg?branch=master&service=github
5-
:target: https://coveralls.io/github/dpkp/kafka-python?branch=master
6-
.. image:: https://travis-ci.org/dpkp/kafka-python.svg?branch=master
7-
:target: https://travis-ci.org/dpkp/kafka-python
4+
.. image:: https://coveralls.io/repos/wbarnha/kafka-python-ng/badge.svg?branch=master&service=github
5+
:target: https://coveralls.io/github/wbarnha/kafka-python-ng?branch=master
6+
.. image:: https://travis-ci.org/wbarnha/kafka-python-ng.svg?branch=master
7+
:target: https://travis-ci.org/wbarnha/kafka-python-ng
88

99
Test environments are managed via tox. The test suite is run via pytest.
1010

1111
Linting is run via pylint, but is generally skipped on pypy due to pylint
1212
compatibility / performance issues.
1313

14-
For test coverage details, see https://coveralls.io/github/dpkp/kafka-python
14+
For test coverage details, see https://coveralls.io/github/wbarnha/kafka-python-ng
1515

1616
The test suite includes unit tests that mock network interfaces, as well as
1717
integration tests that setup and teardown kafka broker (and zookeeper)

‎kafka/version.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,9 @@
1-
__version__ = '2.0.3-dev'
1+
import sys
2+
3+
if sys.version_info < (3, 8):
4+
from importlib_metadata import version
5+
else:
6+
from importlib.metadata import version
7+
8+
9+
__version__ = version("kafka-python-ng")

0 commit comments

Comments
 (0)