Be explicit about async import requirements in README.md #1566
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
There was a problem hiding this comment.
I think this doesn't quite address the linked issue. Their problem was that we import httpx but don't declare a dependency on it. So when they pip install stripe, they have to know to also pip install httpx or there are runtime failures.
To fix, we should either:
- declare a dependency on
httpx(which IMO we shouldn't do until we do some other plumbing upgrades), or - document in the
# Asyncsection that to make async requests, users should also install (/declare a dependency on)httpx
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.
Why?
In #1558, a user reported issues using
_asyncfunctions caused by needing to importhttpx. This PR makes theimportrequirements clearer in our README.What?
import's when using async functionality