https://github.com/opensearch-project/opensearch-sdk-py

OpenSearch Extensions SDK for Python.
https://github.com/opensearch-project/opensearch-sdk-py

hacktoberfest opensearch

Last synced: 2 months ago
JSON representation

OpenSearch Extensions SDK for Python.

• Host: GitHub
• URL: https://github.com/opensearch-project/opensearch-sdk-py
• Owner: opensearch-project
• License: apache-2.0
• Created: 2023-09-06T18:17:56.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2025-04-22T04:34:37.000Z (2 months ago)
• Last Synced: 2025-04-22T06:24:48.891Z (2 months ago)
• Topics: hacktoberfest, opensearch
• Language: Python
• Homepage: https://opensearch.org/blog/introducing-extensions-for-opensearch/
• Size: 1.29 MB
• Stars: 19
• Watchers: 7
• Forks: 10
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
- [OpenSearch Python SDK](#opensearch-python-sdk)

    - [Developing](#developing)

    - [Copyright and License](#copyright-and-license)

# OpenSearch Python SDK

[![tests](https://github.com/opensearch-project/opensearch-sdk-py/actions/workflows/test.yml/badge.svg)](https://github.com/opensearch-project/opensearch-sdk-py/actions/workflows/test.yml)

[![codecov](https://codecov.io/gh/opensearch-project/opensearch-sdk-py/graph/badge.svg?token=YiY0ZUm4lz)](https://codecov.io/gh/opensearch-project/opensearch-sdk-py)

The experimental OpenSearch Python SDK enables you to implement Extensions that provide additional functionality to OpenSearch by registering that functionality through a set of extension points.

When OpenSearch functionality is provided by a REST API, Extensions will use the OpenSearch Python Client to implement it. However, when REST APIs do not provide this information, its binary transport protocol is used. That protocol is implemented in this SDK. Unlike the [OpenSearch Java SDK](https://github.com/opensearch-project/opensearch-sdk-java) the Python implementation reimplements the protocol in pure python.

See [samples/hello](samples/hello/README.md) to get started.

### Developing

See [DEVELOPER_GUIDE](DEVELOPER_GUIDE.md) for implementation details.

### Copyright and License

See [LICENSE](LICENSE.txt)