From a2c4fb961e77e727616d3e867cb299eb07b53232 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=98yvind=20Matheson=20Wergeland?= Date: Fri, 27 Feb 2026 20:36:13 +0100 Subject: [PATCH 1/2] Update readme - Updated authentication mechanisms - Added section on protocols --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 468084e..aea8976 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ A Python SDK which provides easy access to Exabel APIs. pip install exabel ``` -or download from [PyPI](https://pypi.org/project/exabel/). +or download from [PyPI](https://pypi.org/project/exabel). The SDK requires Python 3.10 or later. @@ -32,11 +32,7 @@ Supported data sources are: ## Getting started -To use the SDK against the Data API, Analytics API or Management API, you need an API key provided by Exabel. - -The Exabel Export API can be used by authenticating with username and password. -The first time you run the script a web browser window is opened where you are asked to provide username and password. The script stores an access token in ``~/.exabel``, so you will not be asked again -until the token expires. +To use the SDK against, you need an API key or personal access token. THis can be found in the Exabel app. [Export API Developer guide](https://help.exabel.com/docs/exporting-via-exabel-sdk) @@ -67,3 +63,10 @@ The Exabel Analytics API can be used to manage derived signals and prediction mo The Exabel Management API can be used to manage the library on the Exabel Platform. [Management API Developer guide](https://help.exabel.com/docs/management-api) + +## Protocols + +For efficiency, the SDK uses gRPC when communicating with the Data API, Analytics API, +and Management API. The Export API is only available as a REST API. + +gRPC uses HTTPS on server port 21443, while REST uses HTTPS on server port 443. From 01f37444beaae083d950813c06fd82487aff6b05 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=98yvind=20Matheson=20Wergeland?= Date: Mon, 2 Mar 2026 12:25:49 +0100 Subject: [PATCH 2/2] Review --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index aea8976..295519c 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ Supported data sources are: ## Getting started -To use the SDK against, you need an API key or personal access token. THis can be found in the Exabel app. +To use the SDK against, you need an API key or personal access token. This can be found in the Exabel app. [Export API Developer guide](https://help.exabel.com/docs/exporting-via-exabel-sdk)