Metadata-Version: 2.1
Name: es_client
Version: 8.6.0.post3
Summary: "Elasticsearch Client builder, complete with schema validation"
Home-page: http://github.com/untergeek/es_client
Author: Aaron Mildenstein
Author-email: aaron@mildensteins.com
License: Apache License, Version 2.0
Project-URL: Bug Tracker, https://github.com/untergeek/es_client/issues
Project-URL: Documentation, https://es-client.readthedocs.io/
Project-URL: Source Code, http://github.com/untergeek/es_client
Project-URL: Release Notes, https://github.com/untergeek/es_client/releases
Keywords: elasticsearch
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
License-File: LICENSE

.. _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': 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.
