Cleanup install instructions for optional libs #2139
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Depends on #2123.
This cleans up the install instructions to specify that optional libs
should be installed using the
kafka-python[opt]format. This leveragessetuptools'extra_requiresfeature to let our users choose toinherit any versions pins we might apply to our optional dependencies.
This also re-orders the docs slightly to give more visibility to the
crc32cinstall 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