es-client

https://es-client.readthedocs.io/

You may wonder why this even exists, as at first glance it doesn’t seem to make anything any easier than just using the elasticsearch8 Python module 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
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 (where known)–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': {
        'client': {
            'hosts': 'https://10.0.0.123:9200',
            'ca_certs': '/etc/elasticsearch/certs/ca.crt',
            'request_timeout': 60,
        },
        'other_settings': {
            'master_only': True,
            'username': 'joe_user',
            'password': 'password',
        }
    }
}

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

Additionally, you can read from a YAML configuration file:

---
elasticsearch:
  client:
    hosts: https://10.0.0.123:9200
    ca_certs: /etc/elasticsearch/certs/ca.crt
    request_timeout: 60
  other_settings:
    master_only: true
    username: joe_user
    password: password

from es_client import Builder
from es_client.exceptions import ConfigurationError
from es_client.helpers.utils import get_yaml

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

The same schema validations apply here as well.

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

Uploaded Aug 23, 2022 Source

File details

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

File metadata

Download URL: es_client-8.0.2.tar.gz
Upload date: Aug 23, 2022
Size: 21.4 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for es_client-8.0.2.tar.gz
Algorithm	Hash digest
SHA256	`454e8047de6c98b443dcb0877e5c16e5e7ff0491f4d5f3004078abd51a0a4fb8`
MD5	`935d34b22194cfce9c42498e4afd497d`
BLAKE2b-256	`b5d39506cde853a57305868e525f21d00abe77426b0c0fb20215cb4395cb06ff`