Skip to main content

An API client for Elastic Enterprise Search

Reason this release was yanked:

Users should migrate to v7.10.0+

Project description

Elastic Enterprise Search Logo

CircleCI build

A first-party Python client for Elastic Enterprise Search.

Contents


Getting started 🐣

Supports Python 2.7 and Python 3.3+.

Depends on futures and requests.

Installed with pip <http://pypi.python.org/pypi/pip>:

$ python -m pip install elastic_enterprise_search

You can also download and install the project source:

$ python setup.py install

Usage

Retrieve your access token and a content source key after creating your content source.

Indexing a document into a custom content source:

  from elastic_enterprise_search import Client
  content_source_key = 'content source key'
  authorization_token = 'authorization token'
  client = Client(authorization_token)
  documents = [
    {
      'id': '1234',
      'url': 'https://github.com/elastic/enterprise-search-python',
      'title': 'Elastic Enterprise Search Official Python Client',
      'body': 'A descriptive body, with document contents and metadata'
    }
  ]

  document_results = client.index_documents(content_source_key, documents, timeout=10, delay=2)
  print(document_results)

Change API endpoint

client = Client(authorization_token, "https://your-server.example.com/api/v1/ent")

FAQ 🔮

Where do I report issues with the client?

If something is not working as expected, please open an issue.

Contribute 🚀

We welcome contributors to the project. Before you begin, a couple notes...

License 📗

Apache 2.0 © Elastic

Thank you to all the contributors!

Project details


Download files

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

Source Distribution

elastic_enterprise_search-0.1.0.tar.gz (8.6 kB view details)

Uploaded Source

File details

Details for the file elastic_enterprise_search-0.1.0.tar.gz.

File metadata

  • Download URL: elastic_enterprise_search-0.1.0.tar.gz
  • Upload date:
  • Size: 8.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.23.3 CPython/3.6.5

File hashes

Hashes for elastic_enterprise_search-0.1.0.tar.gz
Algorithm Hash digest
SHA256 545f6601047e71fb8092dd6e4c34ca72f8567e818763406a21853f593b820e8d
MD5 ec3caebd3223983131ee5b13e118e4d9
BLAKE2b-256 4cfdabd8d10a37e995c43712bdcffacd4cd3c6323b051ff0dea97fa6b010f329

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page