Skip to content

Cleanup install instructions for optional libs #2139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 15, 2020

Conversation

jeffwidman
Copy link
Contributor

@jeffwidman jeffwidman commented Oct 12, 2020

Depends on #2123.

This cleans up the install instructions to specify that optional libs
should be installed using the kafka-python[opt] format. This leverages
setuptools' extra_requires feature to let our users choose to
inherit any versions pins we might apply to our optional dependencies.

This also re-orders the docs slightly to give more visibility to the
crc32c install because users are unlikely to realize it exists.

It also cleans up the formatting of the compression libraries slightly,
as they were getting a little unwieldy.


This change is Reviewable

This cleans up the install instructions to specify that optional libs
should be installed using the `kafka-python[opt]` format. This leverages
`setuptools`' `extra_requires` feature to let our users choose to
inherit any versions pins we might apply to our optional dependencies.

This also re-orders the docs slightly to give more visibility to the
`crc32c` install because users are unlikely to realize it exists.

It also cleans up the formatting of the compression libraries slightly,
as they were getting a little unwieldy.
@dpkp dpkp merged commit b0c5930 into master Nov 15, 2020
@jeffwidman jeffwidman deleted the cleanup-install-instructions-for-optional-libs branch March 11, 2021 23:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants