Skip to main content

Python client for Elasticsearch

Project description

Elastic logo

Elasticsearch Python Client

PyPI Version Python Versions Conda Version Downloads
Build Status on GitHub Buildkite Status on Buildkite Documentation Status

The official Python client for Elasticsearch.

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

Download the latest version of Elasticsearch or sign-up for a free trial of Elastic Cloud.

Refer to the Installation section of the getting started documentation.

Connecting

Refer to the Connecting section of the getting started documentation.

Usage


Compatibility

Language clients are forward compatible; meaning that the clients support communicating with greater or equal minor versions of Elasticsearch without breaking. It does not mean that the clients automatically support new features of newer Elasticsearch versions; it is only possible after a release of a new client version. For example, a 8.12 client version won't automatically support the new features of the 8.13 version of Elasticsearch, the 8.13 client version is required for that. Elasticsearch language clients are only backwards compatible with default distributions and without guarantees made.

Elasticsearch Version Elasticsearch-Python Branch Supported
main main
8.x 8.x 8.x
7.x 7.x 7.17

If you have a need to have multiple versions installed at the same time older versions are also released as elasticsearch7 and elasticsearch8.

Documentation

Documentation for the client is available on elastic.co and Read the Docs.

Feedback 🗣️

The engineering team here at Elastic is looking for developers to participate in research and feedback sessions to learn more about how you use our Python client and what improvements we can make to their design and your workflow. If you're interested in sharing your insights into developer experience and language client design, please fill out this short form. Depending on the number of responses we get, we may either contact you for a 1:1 conversation or a focus group with other developers who use the same client. Thank you in advance - your feedback is crucial to improving the user experience for all Elasticsearch developers!

License

This software is licensed under the Apache License 2.0. See NOTICE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

elasticsearch8-8.18.1.tar.gz (750.9 kB view details)

Uploaded Source

Built Distribution

elasticsearch8-8.18.1-py3-none-any.whl (906.7 kB view details)

Uploaded Python 3

File details

Details for the file elasticsearch8-8.18.1.tar.gz.

File metadata

  • Download URL: elasticsearch8-8.18.1.tar.gz
  • Upload date:
  • Size: 750.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for elasticsearch8-8.18.1.tar.gz
Algorithm Hash digest
SHA256 36fe7464d3271fbafc49106f5e58bd5fd8d9719ff2f568d3068f117428f61a4f
MD5 2b3dffd132c5a835a02f90b46fef609e
BLAKE2b-256 16e8f9090837fdcf63982f5daebf7ab1c04d83b4c5d96ac88774b01ddc0eb93d

See more details on using hashes here.

File details

Details for the file elasticsearch8-8.18.1-py3-none-any.whl.

File metadata

File hashes

Hashes for elasticsearch8-8.18.1-py3-none-any.whl
Algorithm Hash digest
SHA256 72e5307d7300308c5c7eb51a4a6ec03a88eae483c4ae427b3ab022d17d5f3790
MD5 cd213483ef44ee2a8e1200dcacf365a8
BLAKE2b-256 f1969454d762c043497358dc498b2018154d18f00b21a02bb831d6e6c83140b0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page