Developer Notes

This document provides information useful to developers working on confluent-kafka-python.

Build

$ python setup.py 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 ...

Note: On Windows the variables for Visual Studio are named INCLUDE and LIB

Install sphinx and sphinx_rtd_theme packages:

$ pip install sphinx sphinx_rtd_theme

Build HTML docs:

$ make docs

Documentation will be generated in docs/_build/.

or:

$ python setup.py build_sphinx

Documentation will be generated in build/sphinx/html.

See tests/README.md for instructions on how to run tests.