Skip to main content

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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

es_client-8.6.1.post1.tar.gz (17.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

es_client-8.6.1.post1-py3-none-any.whl (18.6 kB view details)

Uploaded Python 3

File details

Details for the file es_client-8.6.1.post1.tar.gz.

File metadata

  • Download URL: es_client-8.6.1.post1.tar.gz
  • Upload date:
  • Size: 17.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.23.3

File hashes

Hashes for es_client-8.6.1.post1.tar.gz
Algorithm Hash digest
SHA256 cf94e88b17951801818767f76f17fe3323f9b50910f6f292eacea3fa4f22aba0
MD5 e75a87cbf969b5c4b0c46358366e8498
BLAKE2b-256 f4412ce378b9b8e2606ffa61c62b30d4e9799a6c4c3025a81350e883ab4822f8

See more details on using hashes here.

File details

Details for the file es_client-8.6.1.post1-py3-none-any.whl.

File metadata

File hashes

Hashes for es_client-8.6.1.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 395d60764732ea0beec7064cdcd25ea1f4e0d893aaef480ecdfee130a6f3b4a5
MD5 1b3587f031610cd4fffd893567577f14
BLAKE2b-256 f4275630b9a8b081f9f06afafeab3a9911d6f2879fff5405467fbaed41282f8a

See more details on using hashes here.

Release history Release notifications | RSS feed

9.0.1

2 files

9.0.0

2 files

8.19.5

2 files

8.19.4

2 files

8.19.3

2 files

8.19.2

2 files

8.18.2

2 files

8.18.1

2 files

8.18.0

2 files

8.17.5

2 files

8.17.4

2 files

8.17.3

2 files

8.17.2

2 files

8.17.1

2 files

8.15.2

2 files

8.15.1

2 files

8.15.0

2 files

8.14.2

2 files

8.14.1

2 files

8.14.0

2 files

8.13.5

2 files

8.13.4

2 files

8.13.3

2 files

8.13.2

2 files

8.13.1

2 files

8.13.0

2 files

8.12.9

2 files

8.12.8

2 files

8.12.6

2 files

8.12.5

2 files

8.12.4

2 files

8.12.3

2 files

8.12.2

2 files

8.12.1

2 files

8.12.0

2 files

8.11.0

2 files

8.10.3

2 files

8.10.2

2 files

8.10.1

2 files

8.10.0

2 files

8.9.0

2 files

8.8.2.post1

2 files

8.8.2

2 files

8.7.0

2 files

8.6.2.post1

2 files

8.6.2

2 files

This release

8.6.1.post1 This release

2 files

8.6.1

2 files

8.6.0.post6

2 files

8.6.0.post5

2 files

8.6.0.post4

2 files

8.6.0.post3

1 file

8.6.0.post2

1 file

8.6.0.post1

1 file

8.6.0

1 file

8.5.0

1 file

8.1.0

1 file

8.0.5

1 file

8.0.4

1 file

8.0.3

1 file

8.0.2

1 file

8.0.1

1 file

8.0.0

1 file

1.1.1

2 files

1.1.0

2 files

1.0.1

1 file

1.0.0

1 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