From 51eb6e5cca0a0970334ac228e93a4bd025b73373 Mon Sep 17 00:00:00 2001 From: Sai Medhini Reddy Maryada <117196660+saimedhi@users.noreply.github.com> Date: Fri, 24 Mar 2023 04:55:31 -0700 Subject: [PATCH] Updated user_guide for async client (#338) Signed-off-by: saimedhi --- CHANGELOG.md | 1 + USER_GUIDE.md | 4 ++++ 2 files changed, 5 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 648e5d6f..902285d6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) ### Removed ### Fixed - Fixed import cycle when importing async helpers ([#311](https://github.com/opensearch-project/opensearch-py/pull/311)) +- Fixed userguide for async client ([#311](https://github.com/opensearch-project/opensearch-py/pull/311)) ### Security - Fixed CVE-2022-23491 reported in opensearch-dsl-py ([#295](https://github.com/opensearch-project/opensearch-py/pull/295)) - Update ci workflows ([#318](https://github.com/opensearch-project/opensearch-py/pull/318)) diff --git a/USER_GUIDE.md b/USER_GUIDE.md index 0861bba1..00a2a122 100644 --- a/USER_GUIDE.md +++ b/USER_GUIDE.md @@ -478,6 +478,10 @@ print(response) Make sure to use `AsyncOpenSearch` with the `AsyncHttpConnection` connection class with the async `AWSV4SignerAsyncAuth` signer. +```bash +pip install opensearch-py[async] +``` + ```python from opensearchpy import AsyncOpenSearch, AsyncHttpConnection, AWSV4SignerAsyncAuth import boto3