diff --git a/services/opensearch/README.md b/services/opensearch/README.md new file mode 100644 index 00000000..fe70eaa8 --- /dev/null +++ b/services/opensearch/README.md @@ -0,0 +1,23 @@ +# stackit.opensearch +The STACKIT Opensearch API provides endpoints to list service offerings, manage service instances and service credentials within STACKIT portal projects. + +For more information, please visit [https://docs.stackit.cloud/stackit/en/support-area-72063304.html](https://docs.stackit.cloud/stackit/en/support-area-72063304.html) + +This package is part of the STACKIT Python SDK. For additional information, please visit the [GitHub repository](https://github.com/stackitcloud/stackit-sdk-python) of the SDK. + + +## Installation & Usage +### pip install + +```sh +pip install stackit-opensearch +``` + +Then import the package: +```python +import stackit.opensearch +``` + +## Getting Started + +[Examples](https://github.com/stackitcloud/stackit-sdk-python/tree/main/examples) for the usage of the package can be found in the [GitHub repository](https://github.com/stackitcloud/stackit-sdk-python) of the SDK. \ No newline at end of file diff --git a/services/opensearch/pyproject.toml b/services/opensearch/pyproject.toml index 8868374b..f9857a17 100644 --- a/services/opensearch/pyproject.toml +++ b/services/opensearch/pyproject.toml @@ -5,7 +5,7 @@ authors = [ "OpenAPI Generator Community ", ] description = "STACKIT Opensearch API" -#readme = "README.md" +readme = "README.md" #license = "NoLicense" classifiers = [ "Programming Language :: Python :: 3", @@ -102,4 +102,4 @@ per-file-ignores = """ # E501: long descriptions/string values might lead to lines that are too long # B028: stacklevel for deprecation warning is irrelevant ./src/stackit/*/api/default_api.py: F841,B028,E501 -""" \ No newline at end of file +"""