Skip to main content

"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': '10.0.0.123',
            'use_ssl': True,
            'ca_certs': '/etc/elasticsearch/certs/ca.crt',
            'username': 'joe_user',
            'password': 'password',
            'timeout': 60,
        }
    }
}

client = Builder(config).client

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

es_client-1.0.1.tar.gz (16.5 kB view details)

Uploaded Source

File details

Details for the file es_client-1.0.1.tar.gz.

File metadata

  • Download URL: es_client-1.0.1.tar.gz
  • Upload date:
  • Size: 16.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for es_client-1.0.1.tar.gz
Algorithm Hash digest
SHA256 85f0fb7735f5ad5672d40fd402a315a3c296cbae1519ece3acd7b11b9d141212
MD5 7002e09d723835335b23c2811740289b
BLAKE2b-256 bdb7377abf234959f858797632e569a493006fe1ec7f4bed3a4139ab5a777a21

See more details on using hashes here.

Supported by

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