Skip to main content
Donate to the Python Software Foundation or Purchase a PyCharm License to Benefit the PSF! Donate Now

"Elasticsearch Client builder, complete with schema validation, and AWS boto-based authentication"

Project description

You may wonder why this even exists, as at first glance it doesn’t seem to make anything any easier than just using elasticsearch.Elasticsearch() to build a client connection. I needed to be able to reuse the more complex schema validation bits I was employing, namely:

  • master_only detection
  • AWS IAM credential collection via boto3.session.Session
  • Elasticsearch version checking and validation, and the option to skip this.
  • Configuration value validation, including file paths for SSL certificates, meaning:
    • No unknown keys or unacceptable parameter values are accepted
    • Acceptable values and ranges are established–and easy to amend, if necessary.

So, if you don’t need these, then this library probably isn’t what you’re looking for. If you want these features, then you’ve come to the right place.

Example Usage

from es_client import Builder

config = {
    'elasticsearch': {
        'master_only': True,
        'client': {
            'hosts': '',
            'use_ssl': True,
            'ca_certs': '/etc/elasticsearch/certs/ca.crt',
            'username': 'joe_user',
            'password': 'password',
            'timeout': 60,

    client = Builder(config).client
    # Do exception handling here...

Additionally, you can read from a YAML configuration file:

  master_only: true
    use_ssl: true
    ca_certs: /etc/elasticsearch/certs/ca.crt
    username: joe_user
    password: password
    timeout: 60
from es_client import Builder
from es_client.exceptions import ConfigurationError
from es_client.helpers.utils import get_yaml

    client = Builder(get_yaml('/path/to/es_client.yml').client
    # Do exception handling here...

The same schema validations apply here as well.

Project details

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
es_client-1.1.1-py2.py3-none-any.whl (11.4 kB) Copy SHA256 hash SHA256 Wheel py2.py3
es_client-1.1.1.tar.gz (17.6 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page