README.md

ElasticSearch Python

This example will focus on everything that relates with ElasticSearch in order to create a backend in Python for the OpenBB Terminal Pro. For more information, read our main README.md.

1. Get started with ElasticSearch

Check website: https://www.elastic.co/.

Create an account at https://cloud.elastic.co/login.

2. ElasticSearch and Python

Read the official ElasticSearch connector for python.

TL;DR: Install ElasticSearch with pip install elasticsearch

3. Extract ElasticSearch information

You will need to identify the following from your ElasticSearch account

client = Elasticsearch(
  "XYZ",
  api_key="XYZ"
)

Your Elasticsearch endpoint can be found on the "My deployment" page of your deployment. It will be under Applications, in front of "Elasticsearch" and you can click on "Copy endpoint" directly.

For the API key, you can generate it on the "Management" page under Security.