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',
}
},
'logging': {
'loglevel': 'INFO',
'logfile': '/path/to/file.log',
'logformat': 'default',
}
}
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
logging:
loglevel: INFO
logfile: /path/to/file.log
logformat: default
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.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file es_client-8.18.2.tar.gz.
File metadata
- Download URL: es_client-8.18.2.tar.gz
- Upload date:
- Size: 60.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.13.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
309cf066061cbeae041199ed40dfc6b3d46f1f880348a89219073555b4ca5723
|
|
| MD5 |
95ba3ca222cd9bfffa9a460542c17f21
|
|
| BLAKE2b-256 |
8e2691dfa7dcea56dcb1ef8e3e80599cd6a53b693d19badd5d6944c8654050a4
|
File details
Details for the file es_client-8.18.2-py3-none-any.whl.
File metadata
- Download URL: es_client-8.18.2-py3-none-any.whl
- Upload date:
- Size: 62.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.13.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
be3d7ad237e36b81af3938ef86a80fa897cee7258383d824de46a629bb5d19a7
|
|
| MD5 |
0534f677e8e88c9b55e446ddc31c8eaf
|
|
| BLAKE2b-256 |
79490c3701c1f563dadbdd7a19f95c5f5efaad257ab0b3bf78db07b5be71f6ae
|
