Introduced pyproject.toml and moved static metadata from setup.py

Author: pranavrth

DEVELOPER.md

@@ -5,11 +5,11 @@ This document provides information useful to developers working on confluent-kaf
 
 ## Build
 
-    $ python setup.py build
+    $ python -m build
 
 If librdkafka is installed in a non-standard location provide the include and library directories with:
 
-    $ C_INCLUDE_PATH=/path/to/include LIBRARY_PATH=/path/to/lib python setup.py ...
+    $ C_INCLUDE_PATH=/path/to/include LIBRARY_PATH=/path/to/lib python -m build
 
 **Note**: On Windows the variables for Visual Studio are named INCLUDE and LIB 
 

LICENSE.txt renamed to LICENSE

@@ -1,4 +1,4 @@
 include README.md
-include LICENSE.txt
-include test-requirements.txt
 include src/confluent_kafka/src/*.[ch]
+prune tests
+prune docs

MANIFEST.in

@@ -6,6 +6,7 @@ all:
 
 clean:
 	python setup.py clean
+	rm -rf dist
 	make -C docs clean
 
 .PHONY: docs

Makefile

@@ -42,7 +42,9 @@ need to have a C compiler and librdkafka installed
 ```
 $ python3 -m venv venv_examples
 $ source venv_examples/bin/activate
-$ python setup.py develop
+$ rm -rf dist
+$ python -m build
+$ pip install -e dist/confluent_kafka*whl
 $ cd examples
 $ pip install -r requirements.txt
 ```

examples/README.md

@@ -73,9 +73,10 @@ RUN \
     mkdir -p /usr/src/confluent-kafka-python && \
     cd /usr/src/confluent-kafka-python && \
     rm -rf build && \
-    python3 setup.py clean -a && \
-    python3 setup.py build && \
-    python3 setup.py install && \
+    rm -rf dist && \
+    python3 -m pip install build \
+    python3 -m build && \
+    python3 -m pip install dist/confluent_kafka*whl && \
     cd / && \
     rm -rf /usr/src/confluent-kafka-python
 

examples/docker/Dockerfile.alpine

@@ -0,0 +1,37 @@
+[build-system]
+requires = [ "setuptools>=62", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "confluent-kafka"
+version = "2.1.1"
+description = "\"Confluent's Python client for Apache Kafka\""
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Topic :: Software Development :: Libraries :: Python Modules"]
+dependencies = [ "futures;python_version<\"3.2\"", "enum34;python_version<\"3.4\"",]
+readme = "README.md"
+license = { file = "LICENSE" }
+requires-python = ">=3.7"
+
+[[project.authors]]
+name = "\"Confluent Inc\""
+email = "support@confluent.io"
+
+[project.urls]
+Homepage = "https://github.com/confluentinc/confluent-kafka-python"
+
+[project.optional-dependencies]
+schema-registry = [ "requests",]
+avro = [ "fastavro>=0.23.0,<1.0;python_version<\"3.0\"", "fastavro>=1.0;python_version>\"3.0\"", "avro>=1.11.1,<2", "requests",]
+json = [ "pyrsistent==0.16.1;python_version<\"3.0\"", "pyrsistent;python_version>\"3.0\"", "jsonschema", "requests",]
+protobuf = [ "protobuf", "requests",]
+dev = [ "pytest==4.6.4;python_version<\"3.0\"", "pytest;python_version>=\"3.0\"", "pytest-timeout", "flake8", "fastavro>=0.23.0,<1.0;python_version<\"3.0\"", "fastavro>=1.0;python_version>\"3.0\"", "avro>=1.11.1,<2", "requests",]
+doc = [ "sphinx", "sphinx-rtd-theme", "fastavro>=0.23.0,<1.0;python_version<\"3.0\"", "fastavro>=1.0;python_version>\"3.0\"", "avro>=1.11.1,<2", "requests",]
+
+[tool.setuptools]
+include-package-data = false

pyproject.toml

@@ -1,41 +1,13 @@
 #!/usr/bin/env python
 
 import os
-from setuptools import setup, find_packages
+from setuptools import setup
 from distutils.core import Extension
 import platform
 
-work_dir = os.path.dirname(os.path.realpath(__file__))
-mod_dir = os.path.join(work_dir, 'src', 'confluent_kafka')
+mod_dir = os.path.join('src', 'confluent_kafka')
 ext_dir = os.path.join(mod_dir, 'src')
 
-INSTALL_REQUIRES = [
-    'futures;python_version<"3.2"',
-    'enum34;python_version<"3.4"',
-]
-
-TEST_REQUIRES = [
-    'pytest==4.6.4;python_version<"3.0"',
-    'pytest;python_version>="3.0"',
-    'pytest-timeout',
-    'flake8'
-]
-
-DOC_REQUIRES = ['sphinx', 'sphinx-rtd-theme']
-
-SCHEMA_REGISTRY_REQUIRES = ['requests']
-
-AVRO_REQUIRES = ['fastavro>=0.23.0,<1.0;python_version<"3.0"',
-                 'fastavro>=1.0;python_version>"3.0"',
-                 'avro>=1.11.1,<2',
-                 ] + SCHEMA_REGISTRY_REQUIRES
-
-JSON_REQUIRES = ['pyrsistent==0.16.1;python_version<"3.0"',
-                 'pyrsistent;python_version>"3.0"',
-                 'jsonschema'] + SCHEMA_REGISTRY_REQUIRES
-
-PROTO_REQUIRES = ['protobuf'] + SCHEMA_REGISTRY_REQUIRES
-
 # On Un*x the library is linked as -lrdkafka,
 # while on windows we need the full librdkafka name.
 if platform.system() == 'Windows':
@@ -52,45 +24,4 @@
                             os.path.join(ext_dir, 'AdminTypes.c'),
                             os.path.join(ext_dir, 'Admin.c')])
 
-
-def get_install_requirements(path):
-    content = open(os.path.join(os.path.dirname(__file__), path)).read()
-    return [
-        req
-        for req in content.split("\n")
-        if req != '' and not req.startswith('#')
-    ]
-
-
-trove_classifiers = [
-    'Development Status :: 5 - Production/Stable',
-    'Intended Audience :: Developers',
-    'License :: OSI Approved :: Apache Software License',
-    'Programming Language :: Python',
-    'Programming Language :: Python :: 2.7',
-    'Programming Language :: Python :: 3',
-    'Topic :: Software Development :: Libraries :: Python Modules',
-]
-
-setup(name='confluent-kafka',
-      # Make sure to bump CFL_VERSION* in confluent_kafka/src/confluent_kafka.h
-      # and version in docs/conf.py.
-      version='2.3.0',
-      description='Confluent\'s Python client for Apache Kafka',
-      author='Confluent Inc',
-      author_email='support@confluent.io',
-      url='https://github.com/confluentinc/confluent-kafka-python',
-      ext_modules=[module],
-      packages=find_packages('src'),
-      package_dir={'': 'src'},
-      data_files=[('', [os.path.join(work_dir, 'LICENSE.txt')])],
-      install_requires=INSTALL_REQUIRES,
-      classifiers=trove_classifiers,
-      extras_require={
-          'schema-registry': SCHEMA_REGISTRY_REQUIRES,
-          'avro': AVRO_REQUIRES,
-          'json': JSON_REQUIRES,
-          'protobuf': PROTO_REQUIRES,
-          'dev': TEST_REQUIRES + AVRO_REQUIRES,
-          'doc': DOC_REQUIRES + AVRO_REQUIRES
-      })
+setup(ext_modules=[module])

setup.py

@@ -36,7 +36,7 @@
 
 
 /**
- * @brief confluent-kafka-python version, must match that of setup.py.
+ * @brief confluent-kafka-python version, must match that of pyproject.toml.
  *
  * Hex version representation:
  *  0xMMmmRRPP

src/confluent_kafka/src/confluent_kafka.h

@@ -19,8 +19,7 @@ A python3 env suitable for running tests:
     $ python3 -m venv venv_test
     $ source venv_test/bin/activate
     $ pip install -r tests/requirements.txt
-    $ python setup.py build
-    $ python setup.py install
+    $ python3 -m pip install .
 
 When you're finished with it:
 

tests/README.md

@@ -12,3 +12,4 @@ fastavro
 avro>=1.11.1,<2
 jsonschema
 protobuf
+build

tests/requirements.txt

@@ -32,8 +32,6 @@ set -u
 pushd confluent-kafka-python
 git fetch --tags
 git checkout $cflpy_version
-python3 setup.py clean -a
-python3 setup.py build
 python3 -m pip install .
 popd
 

tests/soak/build.sh

@@ -140,7 +140,7 @@ RCs, so it only needs to be set once for each release.
  * `src/confluent_kafka/src/confluent_kafka.h`
     update both `CFL_VERSION` and `CFL_VERSION_STR`.
  * `docs/conf.py` - change `version` variable.
- * `setup.py` - change `version` argument to `setup()`.
+ * `pyproject.toml` - change `version` field.
 
 Commit these changes with a commit-message containing the version:
 
@@ -290,30 +290,29 @@ With the PR merged to master, check out and update master:
 Now go back to 5.1 and start the final RELEASE ITERATION.
 
 
-### 5.6. Upload wheel packages to PyPi
+### 5.6. Create source distribution
 
-**CANDIDATE ITERATION:** To upload binary packages to test.pypi.org, use:
+When creating the source packages make sure to have checked out the correct tag
+and that you do not have any uncommited modifications and that the `dist/`
+directory is empty.
 
-    $ twine upload -r test dl-v0.11.4rc1/*
+    $ python -m build -s
 
-**RELEASE ITERATION:** To upload binary packages to the proper pypi.org (WARNING!), use:
+The above command will create the necessary source distribution. Move this
+generated sdist file to correct `tools\dl-<tag>` folder
 
-    $ twine upload dl-v0.11.4rc1/*
+    $ mv dist/confluent-kafka-0.11.4rc1.tar.gz tools/dl-v0.11.4rc1/
 
 
-### 5.7. Upload source packages to PyPi
+### 5.7. Upload wheel packages and sdist to PyPi
 
-When uploading source packages make sure to have checked out the correct tag
-and that you do not have any uncommited modifications and that the `build/`
-directory is empty.
-
-**CANDIDATE ITERATION:** Upload source packages to test.pypi.org:
+**CANDIDATE ITERATION:** To upload binary packages to test.pypi.org, use:
 
-    $ python setup.py sdist upload -r test
+    $ twine upload -r test tools/dl-v0.11.4rc1/*
 
-**RELEASE ITERATION:** Upload source packages to the proper pypi.org (WARNING!):
+**RELEASE ITERATION:** To upload binary packages to the proper pypi.org (WARNING!), use:
 
-    $ python setup.py sdist upload
+    $ twine upload tools/dl-v0.11.4rc1/*
 
 
 ### 5.8. Verify installation from PyPi

tools/RELEASE.md

@@ -15,7 +15,7 @@
 #  docker run -t -v $(pwd):/io quay.io/pypa/manylinux2010_x86_64:latest  /io/tools/build-manylinux.sh <librdkafka_tag>
 
 LIBRDKAFKA_VERSION=$1
-PYTHON_VERSIONS=("cp36" "cp37" "cp38" "cp39" "cp310" "cp311" "cp312")
+PYTHON_VERSIONS=("cp37" "cp38" "cp39" "cp310" "cp311" "cp312")
 
 if [[ -z "$LIBRDKAFKA_VERSION" ]]; then
     echo "Usage: $0 <librdkafka_tag>"

tools/build-manylinux.sh

@@ -8,6 +8,7 @@ set -e
 pip install -r docs/requirements.txt
 pip install -U protobuf
 pip install -r tests/requirements.txt
+pip install -U build
 
 lib_dir=dest/runtimes/$OS_NAME-$ARCH/native
 tools/wheels/install-librdkafka.sh "${LIBRDKAFKA_VERSION#v}" dest
@@ -16,7 +17,10 @@ export LDFLAGS="$LDFLAGS -L${PWD}/${lib_dir}"
 export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:$PWD/$lib_dir"
 export DYLD_LIBRARY_PATH="$DYLD_LIBRARY_PATH:$PWD/$lib_dir"
 
-python setup.py build && python setup.py install
+rm -rf dist
+python3 -m build
+pip install dist/confluent_kafka*.whl
+
 if [[ $OS_NAME == linux && $ARCH == x64 ]]; then
     flake8 --exclude ./_venv,*_pb2.py
     make docs

tools/source-package-verification.sh

@@ -13,7 +13,7 @@ set WHEELHOUSE=%4
 if [%WHEELHOUSE%]==[] goto usage
 echo on
 
-set CIBW_BUILD=cp36-%BW_ARCH% cp37-%BW_ARCH% cp38-%BW_ARCH% cp39-%BW_ARCH% cp310-%BW_ARCH% cp311-%BW_ARCH% cp312-%BW_ARCH%
+set CIBW_BUILD=cp37-%BW_ARCH% cp38-%BW_ARCH% cp39-%BW_ARCH% cp310-%BW_ARCH% cp311-%BW_ARCH% cp312-%BW_ARCH%
 set CIBW_BEFORE_BUILD=python -m pip install delvewheel==1.1.4
 set CIBW_TEST_REQUIRES=-r tests/requirements.txt
 set CIBW_TEST_COMMAND=pytest {project}\tests\test_Producer.py

tools/wheels/build-wheels.bat

@@ -8,7 +8,7 @@ this_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 
 
 # Skip PyPy, Python2, old Python3 versions, musl, and x86 builds.
-export CIBW_SKIP="pp* cp27-* cp35-* *i686 *musllinux* $CIBW_SKIP"
+export CIBW_SKIP="pp* cp27-* cp35-* cp36-* *i686 *musllinux* $CIBW_SKIP"
 # Run a simple test suite
 export CIBW_TEST_REQUIRES="-r tests/requirements.txt"
 export CIBW_TEST_COMMAND="pytest {project}/tests/test_Producer.py"