# Elasticsearch Serverless Python Client
<p align="center">
<a href="https://pypi.org/project/elasticsearch-serverless/"><img alt="PyPI Version" src="https://img.shields.io/pypi/v/elasticsearch-serverless" /></a>
<a href="https://pypi.org/project/elasticsearch-serverless/"><img alt="Python Versions" src="https://img.shields.io/pypi/pyversions/elasticsearch-serverless" /></a>
<a href="https://pepy.tech/project/elasticsearch-serverless?versions=*"><img alt="Downloads" src="https://static.pepy.tech/badge/elasticsearch-serverless" /></a>
<a href="https://elasticsearch-serverless-python.readthedocs.io/"><img alt="Documentation Status" src="https://readthedocs.org/projects/elasticsearch-serverless-python/badge/?version=latest" /></a>
</p>
> [!WARNING]
> Starting with the release of the Elastic Stack 9.0.0, this client will be discontinued. Instead, you can use the latest version of the [Elasticsearch Python Client](https://github.com/elastic/elasticsearch-py) to build your Elasticsearch Serverless Python applications.
## Features
* Translating basic Python data types to and from JSON
* Configurable automatic discovery of cluster nodes
* Persistent connections
* Load balancing (with pluggable selection strategy) across available nodes
* Failed connection penalization (time based - failed connections won't be
retried until a timeout is reached)
* Support for TLS and HTTP authentication
* Thread safety across requests
* Pluggable architecture
* Helper functions for idiomatically using APIs together
## Quick Start
```python
# Import the client from the 'elasticsearch' module
# Import the client from the 'elasticsearch' module
>>> from elasticsearch_serverless import Elasticsearch
# Instantiate a client instance
>>> client = Elasticsearch("http://localhost:9200")
# Call an API, in this example `info()`
>>> resp = client.info()
# View the result
>>> resp
{
"name" : "instance-name",
"cluster_name" : "cluster-name",
"cluster_uuid" : "cluster-uuid",
"version" : {
"number" : "7.14.0",
...
},
"tagline" : "You know, for Search"
}
```
## License
This software is licensed under the [Apache License 2.0](./LICENSE). See [NOTICE](./NOTICE).
Raw data
{
"_id": null,
"home_page": null,
"name": "elasticsearch-serverless",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Elastic Client Library Maintainers <client-libs@elastic.co>",
"keywords": "REST, client, elastic, elasticsearch, index, kibana, mapping, search",
"author": null,
"author_email": "Elastic Client Library Maintainers <client-libs@elastic.co>",
"download_url": "https://files.pythonhosted.org/packages/38/20/a8ae00c2cc8f835d61a276d69317343ad75cb0b5565a0da554b76525f5da/elasticsearch_serverless-0.8.0.20231031.tar.gz",
"platform": null,
"description": "# Elasticsearch Serverless Python Client\n\n<p align=\"center\">\n <a href=\"https://pypi.org/project/elasticsearch-serverless/\"><img alt=\"PyPI Version\" src=\"https://img.shields.io/pypi/v/elasticsearch-serverless\" /></a>\n <a href=\"https://pypi.org/project/elasticsearch-serverless/\"><img alt=\"Python Versions\" src=\"https://img.shields.io/pypi/pyversions/elasticsearch-serverless\" /></a>\n <a href=\"https://pepy.tech/project/elasticsearch-serverless?versions=*\"><img alt=\"Downloads\" src=\"https://static.pepy.tech/badge/elasticsearch-serverless\" /></a>\n <a href=\"https://elasticsearch-serverless-python.readthedocs.io/\"><img alt=\"Documentation Status\" src=\"https://readthedocs.org/projects/elasticsearch-serverless-python/badge/?version=latest\" /></a>\n</p>\n\n> [!WARNING]\n> Starting with the release of the Elastic Stack 9.0.0, this client will be discontinued. Instead, you can use the latest version of the [Elasticsearch Python Client](https://github.com/elastic/elasticsearch-py) to build your Elasticsearch Serverless Python applications.\n\n## Features\n\n* Translating basic Python data types to and from JSON\n* Configurable automatic discovery of cluster nodes\n* Persistent connections\n* Load balancing (with pluggable selection strategy) across available nodes\n* Failed connection penalization (time based - failed connections won't be\n retried until a timeout is reached)\n* Support for TLS and HTTP authentication\n* Thread safety across requests\n* Pluggable architecture\n* Helper functions for idiomatically using APIs together\n\n## Quick Start\n\n\n```python\n# Import the client from the 'elasticsearch' module\n# Import the client from the 'elasticsearch' module\n>>> from elasticsearch_serverless import Elasticsearch\n\n# Instantiate a client instance\n>>> client = Elasticsearch(\"http://localhost:9200\")\n\n# Call an API, in this example `info()`\n>>> resp = client.info()\n\n# View the result\n>>> resp\n{\n\"name\" : \"instance-name\",\n\"cluster_name\" : \"cluster-name\",\n\"cluster_uuid\" : \"cluster-uuid\",\n\"version\" : {\n \"number\" : \"7.14.0\",\n ...\n},\n\"tagline\" : \"You know, for Search\"\n}\n```\n\n## License\n\nThis software is licensed under the [Apache License 2.0](./LICENSE). See [NOTICE](./NOTICE).\n",
"bugtrack_url": null,
"license": null,
"summary": "Python client for Elasticsearch Serverless",
"version": "0.8.0.20231031",
"project_urls": {
"Documentation": "https://elasticsearch-serverless-python.readthedocs.io",
"Homepage": "https://github.com/elastic/elasticsearch-serverless-python",
"Issue Tracker": "https://github.com/elastic/elasticsearch-serverless-python/issues",
"Source Code": "https://github.com/elastic/elasticsearch-serverless-python"
},
"split_keywords": [
"rest",
" client",
" elastic",
" elasticsearch",
" index",
" kibana",
" mapping",
" search"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "2d225712308e7176ecb9ec008d93bc7ad6ce23337a88e36f7a1e2f6a53d6045e",
"md5": "0bd392fb4f66d0e2b8adda4ec329732b",
"sha256": "e8b58779f1b20c0d17f853c11e8cc2ccd3da61e43b48eb783173f8de9d568e2a"
},
"downloads": -1,
"filename": "elasticsearch_serverless-0.8.0.20231031-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0bd392fb4f66d0e2b8adda4ec329732b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 404586,
"upload_time": "2025-03-07T07:56:31",
"upload_time_iso_8601": "2025-03-07T07:56:31.256917Z",
"url": "https://files.pythonhosted.org/packages/2d/22/5712308e7176ecb9ec008d93bc7ad6ce23337a88e36f7a1e2f6a53d6045e/elasticsearch_serverless-0.8.0.20231031-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3820a8ae00c2cc8f835d61a276d69317343ad75cb0b5565a0da554b76525f5da",
"md5": "19b6ac39a9e61e09e76413349300409a",
"sha256": "e9189b635619c61ec0645777f3c98a3f240b3b34fbe251f430f77fb24a513a23"
},
"downloads": -1,
"filename": "elasticsearch_serverless-0.8.0.20231031.tar.gz",
"has_sig": false,
"md5_digest": "19b6ac39a9e61e09e76413349300409a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 343696,
"upload_time": "2025-03-07T07:56:33",
"upload_time_iso_8601": "2025-03-07T07:56:33.041869Z",
"url": "https://files.pythonhosted.org/packages/38/20/a8ae00c2cc8f835d61a276d69317343ad75cb0b5565a0da554b76525f5da/elasticsearch_serverless-0.8.0.20231031.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-03-07 07:56:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "elastic",
"github_project": "elasticsearch-serverless-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "elasticsearch-serverless"
}
JSON
