Daniel (dB.) Doubrovkine
f410e81d80
* Fix: build and deploy docs. Signed-off-by: dblock <dblock@amazon.com> * Run nox -rs generate. Signed-off-by: dblock <dblock@amazon.com> --------- Signed-off-by: dblock <dblock@amazon.com>
64 lines
3.9 KiB
Markdown
64 lines
3.9 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!](https://github.com/opensearch-project/opensearch-py#welcome)
|
|
- [User Guide](https://github.com/opensearch-project/opensearch-py#user-guide)
|
|
- [API Doc](https://opensearch-project.github.io/opensearch-py/)
|
|
- [Compatibility with OpenSearch](https://github.com/opensearch-project/opensearch-py#compatibility-with-opensearch)
|
|
- [Project Resources](https://github.com/opensearch-project/opensearch-py#project-resources)
|
|
- [Code of Conduct](https://github.com/opensearch-project/opensearch-py#code-of-conduct)
|
|
- [License](https://github.com/opensearch-project/opensearch-py#license)
|
|
- [Copyright](https://github.com/opensearch-project/opensearch-py#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/) and the [API Doc](https://opensearch-project.github.io/opensearch-py/).
|
|
|
|
## User Guide
|
|
|
|
To get started with the OpenSearch Python Client, see [User Guide](https://github.com/opensearch-project/opensearch-py/blob/main/USER_GUIDE.md). This repository also contains [working samples](https://github.com/opensearch-project/opensearch-py/tree/main/samples) and [benchmarks](https://github.com/opensearch-project/opensearch-py/tree/main/benchmarks).
|
|
|
|
## Compatibility with OpenSearch
|
|
|
|
See [Compatibility](https://github.com/opensearch-project/opensearch-py/blob/main/COMPATIBILITY.md).
|
|
|
|
## Project Resources
|
|
|
|
* [Project Website](https://opensearch.org/)
|
|
* [Downloads](https://opensearch.org/downloads.html)
|
|
* [Documentation](https://opensearch.org/docs/latest/clients/python/)
|
|
* 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
|
|
[opensource-codeofconduct@amazon.com](mailto:opensource-codeofconduct@amazon.com) 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.
|