.. _readme:
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',
}
},
'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.
Raw data
{
"_id": null,
"home_page": null,
"name": "es-client",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "client, command-line, connect, elasticsearch",
"author": null,
"author_email": "Aaron Mildenstein <aaron@mildensteins.com>",
"download_url": "https://files.pythonhosted.org/packages/77/4e/5e3b9a74f402bd08d33fbe1b8eb774a3369e65660dafd1d09d34a2c5cefa/es_client-8.13.3.tar.gz",
"platform": null,
"description": ".. _readme:\n\nes_client\n=========\n\nhttps://es-client.readthedocs.io/\n\nYou may wonder why this even exists, as at first glance it doesn't seem to make\nanything any easier than just using the elasticsearch8 Python module to\nbuild a client connection. I needed to be able to reuse the more complex\nschema validation bits I was employing, namely:\n\n* ``master_only`` detection\n* Elasticsearch version checking and validation, and the option to skip this.\n* Configuration value validation, including file paths for SSL certificates,\n meaning:\n\n * No unknown keys or unacceptable parameter values are accepted\n * Acceptable values and ranges are established (where known)--and easy to\n amend, if necessary.\n\nSo, if you don't need these, then this library probably isn't what you're\nlooking for. If you want these features, then you've come to the right place.\n\nExample Usage\n-------------\n\n::\n\n from es_client import Builder\n\n config = {\n 'elasticsearch': {\n 'client': {\n 'hosts': 'https://10.0.0.123:9200',\n 'ca_certs': '/etc/elasticsearch/certs/ca.crt',\n 'request_timeout': 60,\n },\n 'other_settings': {\n 'master_only': false,\n 'username': 'joe_user',\n 'password': 'password',\n }\n },\n 'logging': {\n 'loglevel': 'INFO',\n 'logfile': '/path/to/file.log',\n 'logformat': 'default',\n }\n }\n\n builder = Builder(configdict=config)\n\n try:\n builder.connect()\n except:\n # Do exception handling here...\n\n client = builder.client\n\nAdditionally, you can read from a YAML configuration file:\n\n::\n\n ---\n elasticsearch:\n client:\n hosts: https://10.0.0.123:9200\n ca_certs: /etc/elasticsearch/certs/ca.crt\n request_timeout: 60\n other_settings:\n master_only: false\n username: joe_user\n password: password\n logging:\n loglevel: INFO\n logfile: /path/to/file.log\n logformat: default\n\n::\n\n from es_client import Builder\n\n builder = Builder(configfile='/path/to/es_client.yml')\n\n try:\n builder.connect()\n except:\n # Do exception handling here...\n\n client = builder.client\n\nThe same schema validations apply here as well.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Elasticsearch Client builder, complete with schema validation",
"version": "8.13.3",
"project_urls": {
"Bug Tracker": "https://github.com/untergeek/es_client/issues",
"Documentation": "https://es-client.readthedocs.io/",
"Homepage": "https://github.com/untergeek/es_client",
"Release Notes": "https://github.com/untergeek/es_client/releases",
"Source Code": "http://github.com/untergeek/es_client"
},
"split_keywords": [
"client",
" command-line",
" connect",
" elasticsearch"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5e7fc56bbb45af588018668012c22e98722d033156647886bd26656eb8b33c3b",
"md5": "cb48b169357de3b79b7035f9432d37a7",
"sha256": "ef117b797f854dca64805c82bd0bddc19e6bd2a7b7f11a0eca2a2aac323efdc8"
},
"downloads": -1,
"filename": "es_client-8.13.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cb48b169357de3b79b7035f9432d37a7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 33495,
"upload_time": "2024-04-26T14:14:48",
"upload_time_iso_8601": "2024-04-26T14:14:48.789998Z",
"url": "https://files.pythonhosted.org/packages/5e/7f/c56bbb45af588018668012c22e98722d033156647886bd26656eb8b33c3b/es_client-8.13.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "774e5e3b9a74f402bd08d33fbe1b8eb774a3369e65660dafd1d09d34a2c5cefa",
"md5": "cf15ac975a6d64c2b590f1599180111a",
"sha256": "dda3e4b2eb7fc2d02ae63c02cf22bb6595c4962386ecddd51bd410c321a6344b"
},
"downloads": -1,
"filename": "es_client-8.13.3.tar.gz",
"has_sig": false,
"md5_digest": "cf15ac975a6d64c2b590f1599180111a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 29795,
"upload_time": "2024-04-26T14:14:50",
"upload_time_iso_8601": "2024-04-26T14:14:50.301121Z",
"url": "https://files.pythonhosted.org/packages/77/4e/5e3b9a74f402bd08d33fbe1b8eb774a3369e65660dafd1d09d34a2c5cefa/es_client-8.13.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-26 14:14:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "untergeek",
"github_project": "es_client",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "es-client"
}
JSON
