Vacha ShahandGitHub
172a3179ab
* Adding support to run integration tests across various versions of OpenSearch Signed-off-by: Vacha Shah <[email protected]> * Adding a compatibility matrix and getting started guide with formatting Signed-off-by: Vacha Shah <[email protected]> * Splitting jobs for opendistro and opensearch Signed-off-by: Vacha Shah <[email protected]>
65 lines
3.2 KiB
Markdown
65 lines
3.2 KiB
Markdown
|
|
[](https://github.com/opensearch-project/opensearch-py/actions/workflows/unified-release.yml)
|
|
[](https://github.com/opensearch-project/opensearch-py/actions/workflows/ci.yml)
|
|
[](https://github.com/opensearch-project/opensearch-py/actions/workflows/integration.yml)
|
|
[](https://discuss.opendistrocommunity.dev/c/clients/)
|
|
|
|
|
|
|
|
|
|
OpenSearch Python Client
|
|
|
|
- [Welcome!](#welcome)
|
|
- [Getting Started](#getting-started)
|
|
- [Compatibility with OpenSearch](#compatibility-with-opensearch)
|
|
- [Project Resources](#project-resources)
|
|
- [Code of Conduct](#code-of-conduct)
|
|
- [License](#license)
|
|
- [Copyright](#copyright)
|
|
|
|
## Welcome!
|
|
|
|
**opensearch-py** is [a community-driven, open source fork](https://aws.amazon.com/blogs/opensource/introducing-opensearch/)
|
|
of elasticsearch-py licensed under the [Apache v2.0 License](https://github.com/opensearch-project/opensearch-py/blob/main/LICENSE.txt).
|
|
For more information, see [opensearch.org](https://opensearch.org/).
|
|
|
|
This is the low-level client. A high-level Python client is in the works, and will be available soon.
|
|
|
|
## Getting Started
|
|
|
|
To get started with the OpenSearch Python Client, see [Getting Started](GETTING_STARTED.md).
|
|
|
|
## Compatibility with OpenSearch
|
|
|
|
See [Compatibility](COMPATIBILITY.md).
|
|
|
|
## Project Resources
|
|
|
|
* [Project Website](https://opensearch.org/)
|
|
* [Downloads](https://opensearch.org/downloads.html)
|
|
* [Documentation](https://opensearch.org/docs/)
|
|
* Need help? Try [Forums](https://discuss.opendistrocommunity.dev/)
|
|
* [Project Principles](https://opensearch.org/#principles)
|
|
* [Contributing to OpenSearch](https://github.com/opensearch-project/opensearch-py/blob/main/CONTRIBUTING.md)
|
|
* [Maintainer Responsibilities](https://github.com/opensearch-project/opensearch-py/blob/main/MAINTAINERS.md)
|
|
* [Release Management](https://github.com/opensearch-project/opensearch-py/blob/main/RELEASING.md)
|
|
* [Admin Responsibilities](https://github.com/opensearch-project/opensearch-py/blob/main/ADMINS.md)
|
|
* [Security](https://github.com/opensearch-project/opensearch-py/blob/main/SECURITY.md)
|
|
|
|
## Code of Conduct
|
|
|
|
This project has adopted the
|
|
[Amazon Open Source Code of Conduct](https://github.com/opensearch-project/opensearch-py/blob/main/CODE_OF_CONDUCT.md).
|
|
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq), or contact
|
|
[[email protected]](mailto:[email protected]) with any additional questions or comments.
|
|
|
|
## License
|
|
|
|
This project is licensed under the
|
|
[Apache v2.0 License](https://github.com/opensearch-project/opensearch-py/blob/main/LICENSE.txt).
|
|
|
|
## Copyright
|
|
|
|
Copyright OpenSearch Contributors. See
|
|
[NOTICE](https://github.com/opensearch-project/opensearch-py/blob/main/NOTICE.txt) for details.
|