Installation
The sections below describe how to install and use the Engage Smarter Python library. We will be offering a Typescript library as well (in development).
Python library
The simplest way to make your first API request is by using the Engage Smarter AI Python library. For this, you will need to have Python installed and (optionally) have set up a virtual environment.
If you already have these, feel free to skip to the section Installing the Engage Smarter library.
Installing Python
To use the Engage Smarter Python library, you will need to have Python installed.
If you do not already have Python installed, you can download the latest version from the official Python website. To use the Engage Smarter Python library, you will need to have Python version 3.9 or above installed. If you are installing Python for the first time, you can follow the official Python beginners installation guide for your operating system.
Setting up a virtual environment (optional)
We recommend using a virtual environment to manage your Python dependencies. This will ensure that your Python dependencies are isolated from other Python projects on your machine. If you are not familiar with virtual environments, you can read more about them in the Python documentation.
The following command will create a virtual environment in a .venv directory in your current working directory:
python -m venv .venv
To activate your virtual environment, run the following command on macOS/Linux:
source .venv/bin/activate
Or the following command on Windows:
.venv\Scripts\activate
After running that command, you should see (.venv) to the left of your terminal prompt. This indicates that you are now working in your virtual environment.
Installing the Engage Smarter library
Once you have installed Python and (optionally) activated a virtual environment, you should install the library.
The Engage Smarter Python library is availble via a simple pip install.
pip install engagesmarter-py
Within our library the main package is called engagesmarter which you can import in the normal way within your Python code or notebook.
from engagesmarter import Client
Our Python API library is under ongoing development and may be subject to breaking changes in future versions.
We also welcome feedback and input from developers on how to improve the Python library.
Library documentation is available on PyPi.