Updated user_guide for async client #340
Merged
Conversation
This file contains 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
saimedhi
requested review from
VachaShah,
dblock,
harshavamsi,
axeoman,
deztructor and
Shephalimittal
as code owners
dblock
reviewed
Mar 28, 2023
USER_GUIDE.md
Outdated
| @@ -45,6 +46,12 @@ from opensearchpy import OpenSearch | |||
|
|
|||
| If you prefer to add the client manually or just want to examine the source code, see [opensearch-py on GitHub](https://github.com/opensearch-project/opensearch-py). | |||
|
|
|||
| To add the async client to your project, install it using [pip](https://pip.pypa.io/) as below: | |||
There was a problem hiding this comment.
Swap this with the line above?
We don't say "as below" above, so remove it.
USER_GUIDE.md
Outdated
| pip install opensearch-py[async] | ||
| ``` | ||
| #### Pre-requisites to use `AWSV4SignerAsyncAuth` | ||
| - Setup the async client as given [here](https://github.com/opensearch-project/opensearch-py/blob/main/USER_GUIDE.md#setup) |
There was a problem hiding this comment.
I would just say, "Requires opensearch-py[async].", keep it short. I don't think this needs a new section.
Signed-off-by: saimedhi <saimedhi@amazon.com>
saimedhi
force-pushed
the
fix/async_userguide
branch
from
aeda641
to
bebab2d
Compare
dblock
approved these changes
Mar 28, 2023
roma2023
pushed a commit
to roma2023/opensearch-py
that referenced
this pull request
May 9, 2023
Signed-off-by: saimedhi <saimedhi@amazon.com> Signed-off-by: Raman Saparkhan <romasaparhan19@gmail.com>
roma2023
pushed a commit
to roma2023/opensearch-py
that referenced
this pull request
Jul 4, 2023
Signed-off-by: saimedhi <saimedhi@amazon.com> Signed-off-by: Raman Saparkhan <romasaparhan19@gmail.com>
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.
Description
Updated user_guide for async client
Issues Resolved
Closes #332
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.