SDK Documentation
How to install and use Ango Hub's Python SDK.
Last updated
How to install and use Ango Hub's Python SDK.
Last updated
We provide a Python SDK to interface programmatically with Ango Hub.
To start using the Ango SDK, you will need to install the latest version of the imerit-ango python package, available on .
To download and add the package to your current Python environment, use the following command:
To upgrade the imerit-ango package to its latest version in your current Python environment, use the following command:
In order to interact with Ango Hub programmatically, you’ll need an API key which can be directly obtained from the .
Or follow these steps to obtain one:
Navigate to your Account page in Ango Hub.
Go to the API tab.
Create a new API key or copy your existing key.
For more information, please visit the page.
To obtain an organization's ID from the UI:
You'll see a row called Organization ID. Click on the "Clipboard" button next to it to copy the ID to your clipboard.
To obtain a project’s ID, open the project in Ango Hub and look at the URL in your browser’s address bar. The URL will follow this format:
https://imerit.ango.ai/projects/<project_id>
Simply copy the <project_id> from the URL.
To obtain a Task or Asset ID:
Navigate to the Tasks or Assets tab in your project.
Open the task or asset you need.
In the right-hand panel, under Task Info, you’ll find the relevant ID.
To make this process easier, you can use the Copy to Clipboard button available in the interface.
Snippets on this page make the assumption that you have your API key and other variables set as environmental variables.
To set environmental variables, install the python-dotenv package from pip by running
in your Python environment.
Then, create a file called .env in your environment's root folder. The contents of this .env file will look like this:
In your Python scripts, import the package and load the environmental variables by running load_dotenv() before using the variables in your script.
You will then be able to access your environmental variables by using os.getenv("VAR_NAME"), like so:
Ango Hub assigns unique IDs to , , , and . These IDs are often required for interacting with the SDK.
Navigate to your page.