Overview

The Cloud SDK is a lightweight Python module which can interact with various Formant cloud capabilities such as querying for devices and telemetry data, ingesting data without an agent, and issuing commands.

Pre-requisites for using the formant cloud python module

Installation

pip install formant, or
pip3 install formant

Authentication

Service account authentication is necessary to use the Cloud SDK. To create a service account, you can use fctl, the Formant administrative command line tool.

See: https://help.formant.io/device-management/installing-fctl

Once you have installed and authenticated fctl with your administrator email and password, create a service account. Run:

fctl create service-account -h

to see an example.

After successfully running this command, fctl will output the required credentials for your service account, including service account email and password.

Store these credentials in a secure location. This is the only time you will be able to copy this password.