Skip to content
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.

Sign up for GitHub

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

Add more information to Python docs #7506

Merged
merged 5 commits into from
Jul 2, 2024
Merged

Add more information to Python docs #7506

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
771f481
addresources
hdhalter Jun 25, 2024
dde7628
fixedlinks
hdhalter Jun 25, 2024
7f1992a
Merge branch 'main' into add-python-resources
vagimeli Jun 28, 2024
7561ec1
Update _clients/python-low-level.md
vagimeli Jun 28, 2024
110ecb2
Merge branch 'main' into add-python-resources
vagimeli Jul 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions _clients/python-low-level.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,15 @@ redirect_from:

# Low-level Python client

The OpenSearch low-level Python client (`opensearch-py`) provides wrapper methods for the OpenSearch REST API so that you can interact with your cluster more naturally in Python. Rather than sending raw HTTP requests to a given URL, you can create an OpenSearch client for your cluster and call the client's built-in functions. For the client's complete API documentation and additional examples, see the [`opensearch-py` API documentation](https://opensearch-project.github.io/opensearch-py/).
The OpenSearch low-level Python client (`opensearch-py`) provides wrapper methods for the OpenSearch REST API so that you can interact with your cluster more naturally in Python. Rather than sending raw HTTP requests to a given URL, you can create an OpenSearch client for your cluster and call the client's built-in functions.

This getting started guide illustrates how to connect to OpenSearch, index documents, and run queries. For the client source code, see the [`opensearch-py` repo](https://github.com/opensearch-project/opensearch-py).
This getting started guide illustrates how to connect to OpenSearch, index documents, and run queries. For additional information, see the following resources:
- [OpenSearch Python repo](https://github.com/opensearch-project/opensearch-py)
- [API reference](https://opensearch-project.github.io/opensearch-py/api-ref.html)
- [User guides](https://github.com/opensearch-project/opensearch-py/tree/main/guides)
- [Samples](https://github.com/opensearch-project/opensearch-py/tree/main/samples)

If you have any questions or would like to contribute, you can [create an issue](https://github.com/opensearch-project/opensearch-py/issues) to interact with the OpenSearch Python team directly.

## Setup

Expand Down
Loading