Skip to main content

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.

Metadata

Release files for es-client 8.6.0.post1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for es-client 8.6.0.post1
File Size Uploaded
es_client-8.6.0.post1.tar.gz 25.7 kB Details

Release files / es_client-8.6.0.post1.tar.gz

Download URL es_client-8.6.0.post1.tar.gz
Size 25.7 kB
Tags Source
SHA-256 checksum
How to use checksums
4e7d6ce38e365f9564887835ceea9e54f7bb269250f14904f4d46b4ccbb4edae
BLAKE2b-256 checksum
How to use checksums
54028800aaa329d506d6a01ef5589af2658291e6970c0648b74697aeee0bb11e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.10.6

Release history Release notifications | RSS feed

9.0.1

2 release files

9.0.0

2 release files

8.19.2

2 release files

8.18.2

2 release files

8.18.1

2 release files

8.18.0

2 release files

8.17.5

2 release files

8.17.4

2 release files

8.17.2

2 release files

8.17.1

2 release files

8.15.2

2 release files

8.15.1

2 release files

8.15.0

2 release files

8.13.4

2 release files

8.13.3

2 release files

8.13.2

2 release files

8.13.1

2 release files

8.12.9

2 release files

8.12.8

2 release files

8.12.6

2 release files

8.12.1

2 release files

8.12.0

2 release files

8.11.0

2 release files

8.10.1

2 release files

8.10.0

2 release files

8.9.0

2 release files

8.8.2

2 release files

8.7.0

2 release files

8.6.2

2 release files

8.6.1

2 release files

This release

8.6.0.post1 This release

1 release file

8.6.0

1 release file

8.5.0

1 release file

8.1.0

1 release file

8.0.5

1 release file

8.0.4

1 release file

8.0.3

1 release file

8.0.2

1 release file

8.0.1

1 release file

8.0.0

1 release file

1.1.1

2 release files

1.1.0

2 release files

1.0.1

1 release file

1.0.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page