Elasticsearch Serverless Python Client
======================================
.. image:: https://img.shields.io/pypi/v/elasticsearch-serverless
:target: https://pypi.org/project/elasticsearch-serverless
.. image:: https://img.shields.io/conda/vn/conda-forge/elasticsearch-serverless?color=blue
:target: https://anaconda.org/conda-forge/elasticsearch-serverless
.. image:: https://static.pepy.tech/badge/elasticsearch-serverless
:target: https://pepy.tech/project/elasticsearch-serverless?versions=*
.. image:: https://clients-ci.elastic.co/job/elastic+elasticsearch-serverless-python+main/badge/icon
:target: https://clients-ci.elastic.co/job/elastic+elasticsearch-serverless-python+main
.. image:: https://readthedocs.org/projects/elasticsearch-serverless-python/badge/?version=latest&style=flat
:target: https://elasticsearch-serverless-python.readthedocs.io
*The official Python client for Elasticsearch Serverless.*
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
Installation
------------
Install the ``elasticsearch-serverless`` package with `pip
<https://pypi.org/project/elasticsearch-serverless>`_::
$ python -m pip install elasticsearch-serverless
If your application uses async/await in Python you can install with
the ``async`` extra::
$ python -m pip install elasticsearch-serverless[async]
Read more about `how to use asyncio with this project <https://elasticsearch-serverless-python.readthedocs.io/en/latest/async.html>`_.
Compatibility
-------------
TODO
Documentation
-------------
Documentation for the client is `available on elastic.co`_ and `Read the Docs`_.
.. _available on elastic.co: https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/index.html
.. _Read the Docs: https://elasticsearch-serverless-python.readthedocs.io
Quick Start
-----------
.. code-block:: python
# 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"
}
You can read more about `configuring the client`_ in the documentation.
.. _configuring the client: https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/connecting.html
License
-------
Copyright 2023 Elasticsearch B.V. Licensed under the Apache License, Version 2.0.
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/94/51/71af4c892f6ae7c38efe48723eff9c2aebcbfd2d56a21050dea59e40f59f/elasticsearch_serverless-0.7.0.20231031.tar.gz",
"platform": null,
"description": "Elasticsearch Serverless Python Client\n======================================\n\n.. image:: https://img.shields.io/pypi/v/elasticsearch-serverless\n :target: https://pypi.org/project/elasticsearch-serverless\n\n.. image:: https://img.shields.io/conda/vn/conda-forge/elasticsearch-serverless?color=blue\n :target: https://anaconda.org/conda-forge/elasticsearch-serverless\n\n.. image:: https://static.pepy.tech/badge/elasticsearch-serverless\n :target: https://pepy.tech/project/elasticsearch-serverless?versions=*\n\n.. image:: https://clients-ci.elastic.co/job/elastic+elasticsearch-serverless-python+main/badge/icon\n :target: https://clients-ci.elastic.co/job/elastic+elasticsearch-serverless-python+main\n\n.. image:: https://readthedocs.org/projects/elasticsearch-serverless-python/badge/?version=latest&style=flat\n :target: https://elasticsearch-serverless-python.readthedocs.io\n\n*The official Python client for Elasticsearch Serverless.*\n\n\nFeatures\n--------\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\nInstallation\n------------\n\nInstall the ``elasticsearch-serverless`` package with `pip\n<https://pypi.org/project/elasticsearch-serverless>`_::\n\n $ python -m pip install elasticsearch-serverless\n\nIf your application uses async/await in Python you can install with\nthe ``async`` extra::\n\n $ python -m pip install elasticsearch-serverless[async]\n\nRead more about `how to use asyncio with this project <https://elasticsearch-serverless-python.readthedocs.io/en/latest/async.html>`_.\n\n\nCompatibility\n-------------\n\nTODO\n\n\nDocumentation\n-------------\n\nDocumentation for the client is `available on elastic.co`_ and `Read the Docs`_.\n\n.. _available on elastic.co: https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/index.html\n.. _Read the Docs: https://elasticsearch-serverless-python.readthedocs.io\n\nQuick Start\n-----------\n\n.. code-block:: python\n\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\nYou can read more about `configuring the client`_ in the documentation.\n\n.. _configuring the client: https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/connecting.html\n\n\nLicense\n-------\n\nCopyright 2023 Elasticsearch B.V. Licensed under the Apache License, Version 2.0.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Python client for Elasticsearch Serverless",
"version": "0.7.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": "",
"digests": {
"blake2b_256": "42a224fd94c65028c75c360c3baee8a259652a2ea0dbe8bfd2406de8304ce995",
"md5": "1c7618c63e4575c1866f1efbebed0d9a",
"sha256": "6963c0327e46d7b68f5d3fda806b958d779a6641e2758107172e3c81c63a3c3c"
},
"downloads": -1,
"filename": "elasticsearch_serverless-0.7.0.20231031-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1c7618c63e4575c1866f1efbebed0d9a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 327046,
"upload_time": "2024-12-11T13:21:41",
"upload_time_iso_8601": "2024-12-11T13:21:41.156264Z",
"url": "https://files.pythonhosted.org/packages/42/a2/24fd94c65028c75c360c3baee8a259652a2ea0dbe8bfd2406de8304ce995/elasticsearch_serverless-0.7.0.20231031-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "945171af4c892f6ae7c38efe48723eff9c2aebcbfd2d56a21050dea59e40f59f",
"md5": "1f49fc09ced391be88a3987df38e771e",
"sha256": "1411605db5ebb1117de36789664f0d44858c0984d48525e85d4dc07a615ea3ed"
},
"downloads": -1,
"filename": "elasticsearch_serverless-0.7.0.20231031.tar.gz",
"has_sig": false,
"md5_digest": "1f49fc09ced391be88a3987df38e771e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 266579,
"upload_time": "2024-12-11T13:21:45",
"upload_time_iso_8601": "2024-12-11T13:21:45.936867Z",
"url": "https://files.pythonhosted.org/packages/94/51/71af4c892f6ae7c38efe48723eff9c2aebcbfd2d56a21050dea59e40f59f/elasticsearch_serverless-0.7.0.20231031.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-11 13:21:45",
"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
