Install the Elementary Python SDK to start sending data quality information to Elementary Cloud.
Prerequisites
- Python 3.8 or higher
- An Elementary Cloud account
- API key and environment ID from your Elementary Cloud account
Install via pip
pip install elementary-python-sdk
Install via poetry
poetry add elementary-python-sdk
Verify Installation
After installation, verify that the SDK is correctly installed:
import elementary_python_sdk
print(elementary_python_sdk.__version__)
Get Your Credentials
To use the Python SDK, you’ll need:
- Project ID - Your Python project identifier (choose any string to identify your code project; used to deduplicate and identify reported assets)
- API Key - Your Elementary Cloud API token
- URL - The full endpoint URL:
{base_url}/sdk-ingest/{env_id}/batch
- Example:
https://app.elementary-data.com/sdk-ingest/a6b2425d-36e2-4e13-8458-9825688ca1f2/batch
Generate an Access Token
You can generate tokens directly from the Elementary UI:
- Go to User → Personal Tokens or Account → Account Tokens
- Click Generate token
- (Optional) Add a name/description for the token
- Copy the token and store it securely — it is shown only once
For detailed instructions, see the API Reference or the MCP Setup Guide.
Keep your API key secure. Never commit it to version control. Use environment variables or a secrets management system.
Next Steps
