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.0.tar.gz (746.9 kB view details)

Uploaded Source

Built Distribution

elasticsearch8-8.18.0-py3-none-any.whl (895.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: elasticsearch8-8.18.0.tar.gz
  • Upload date:
  • Size: 746.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.0.tar.gz
Algorithm Hash digest
SHA256 e2ac31b99068b7a520d92d458780eb641a6f7d7ffbe1a80360acc688f1752136
MD5 b5280b5207d817d7a04afcd190caa6db
BLAKE2b-256 47e6b4f1b8dcb8fead5762d2dc9347d8977b72218d5f0286a9ef16add3fe34a5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for elasticsearch8-8.18.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ece835ae16854a91539275dd6bee3b6ab6b6c248cf2c3a6f4372e85f4e3345e4
MD5 13ea6152a9bf7e467aa8c4e9b7d34631
BLAKE2b-256 0164d024c2c7a71706fbe36a247c3d2034e9701ebc1049067bb9553a795c5f4d

See more details on using hashes here.

Supported by

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