Skip to main content

Installation

The Atlan Application SDK is available on PyPI and can be installed with your preferred Python package manager.

Requirements

Python 3.11 or higher is required. The SDK supports Python 3.11, 3.12, and 3.13.

Install the SDK

pip install atlan-application-sdk
This installs the core SDK with essential dependencies including:
  • FastAPI for the web server
  • Pydantic for data validation
  • PyAtlan for Atlan API access
  • DuckDB for local data processing
  • Loguru for logging

Optional dependencies

The SDK provides optional extras for specific functionality:

Workflow orchestration

Required for Temporal workflow support:
pip install atlan-application-sdk[workflows]
Includes:
  • Temporal Python SDK
  • Dapr SDK
  • orjson for fast JSON serialization

SQL database support

For SQLAlchemy-based database connections:
pip install atlan-application-sdk[sqlalchemy]

Cloud provider support

For AWS IAM authentication and Secrets Manager:
pip install atlan-application-sdk[iam_auth]
Includes boto3 for AWS SDK access.

Data processing

Pandas and PyArrow are included in the base installation for data processing.
For distributed data processing with Daft:
pip install atlan-application-sdk[daft]

Development and testing

For test utilities and validation:
pip install atlan-application-sdk[tests]
Includes pytest-order and pandera for data validation.
For Redis-based distributed locks:
pip install atlan-application-sdk[distributed_lock]
For Model Context Protocol integration:
pip install atlan-application-sdk[mcp]

Install all extras

To install the SDK with all optional dependencies:
pip install atlan-application-sdk[workflows,sqlalchemy,iam_auth,azure,daft,tests,distributed_lock,mcp]

Docker images

Pre-built Docker images are available from the Atlan Harbor registry:
# Latest version
docker pull registry.atlan.com/public/application-sdk:main-latest

# Specific version
docker pull registry.atlan.com/public/application-sdk:main-2.5.0

# Commit-specific image
docker pull registry.atlan.com/public/application-sdk:sha-49c027f
Docker images include all dependencies and are ready for production deployment.

Verify installation

Verify the installation by checking the version:
from application_sdk import __version__

print(__version__)  # Should print: 2.5.0

Next steps

Quickstart

Build your first application

Core concepts

Learn the fundamentals

Build docs developers (and LLMs) love