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': false,
            'username': 'joe_user',
            'password': 'password',
        }
    }
}

builder = Builder(configdict=config)

try:
    builder.connect()
except:
    # Do exception handling here...

client = builder.client

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: false
    username: joe_user
    password: password
from es_client import Builder

builder = Builder(configfile='/path/to/es_client.yml')

try:
    builder.connect()
except:
    # Do exception handling here...

client = builder.client

The same schema validations apply here as well.

Metadata

Release files for es-client 8.6.0.post6

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.post6
File Size Uploaded
es_client-8.6.0.post6.tar.gz 18.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for es-client 8.6.0.post6
File Interpreter ABI Platform
es_client-8.6.0.post6-py3-none-any.whl Python 3 none any Details

Total release size: 36.6 kB

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

Download URL es_client-8.6.0.post6.tar.gz
Size 18.1 kB
Tags Source
SHA-256 checksum
How to use checksums
9a22889ee0af6926609369fb49a5cfa6f70e1a077a6b099981f043a4174743c6
BLAKE2b-256 checksum
How to use checksums
e03349131984ee26cfb225d456db4c04a274a1e43b4a21d67285ae6fce497789
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.28.2

Release files / es_client-8.6.0.post6-py3-none-any.whl

Download URL es_client-8.6.0.post6-py3-none-any.whl
Size 18.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
060ed899d5d062e8fdd83a92569def3d6b4e8595c72afb97f0e58ed23e9b2ec7
BLAKE2b-256 checksum
How to use checksums
7ed743a821297123237b9efe9d876ee4b37e1ddbc16be2f168459ef4e816b814
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.28.2

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.post6 This release

2 release files

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