swiftype-enterprise 1.0.0

An API client for Swiftype Enterprise

A first-party Python client for Elastic Enterprise Search.

Contents

• Getting started
• Usage
• FAQ
• Contribute
• License

---

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 swiftype_enterprise

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 swiftype_enterprise import SwiftypeEnterpriseClient
  content_source_key = 'content source key'
  authorization_token = 'authorization token'
  client = SwiftypeEnterpriseClient(authorization_token)
  documents = [
    {
      'id': '1234',
      'url': 'https://github.com/swiftype/swiftype-enterprise-python',
      'title': 'Swiftype Enterprise Python Github',
      '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 = SwiftypeEnterpriseClient(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...

• Before opening a pull request, please create an issue to discuss the scope of your proposal.
• Please write simple code and concise documentation, when appropriate.

License 📗

MIT © Elastic

Thank you to all the contributors!