atlan-application-sdk 2.8.4

Atlan Application SDK is a Python library for developing applications on the Atlan Platform

Atlan Application SDK

The Atlan Application SDK is a Python library designed for building applications on the Atlan platform. It offers a full PaaS (Platform-as-a-Service) toolkit — from local development to deployment and partner collaboration — so you can create integrations and tools that seamlessly extend the Atlan experience for our mutual customers.

Usage

Install atlan-application-sdk as a dependency in your project:

• Using pip:

# pip install the latest version from PyPI
pip install atlan-application-sdk

• Using alternative package managers:

# Using uv to install the latest version from PyPI
uv add atlan-application-sdk

# OR using Poetry to install the latest version from PyPI
poetry add atlan-application-sdk

[!TIP] View sample apps built using Application SDK here

Getting Started

• Want to develop locally or run examples from this repository? Check out our Getting Started Guide for a step-by-step walkthrough!
• Detailed documentation for the application-sdk is available at docs folder.

🐳 Docker

Pre-built Base Image (Harbor)

The app-runtime-base image provides the runtime environment (Python, Dapr, OS packages) for Atlan apps. It does not include the SDK itself — install atlan-application-sdk via pip/uv in your app's Dockerfile.

# Latest main image
docker pull registry.atlan.com/public/app-runtime-base:main-latest

# Versioned image
docker pull registry.atlan.com/public/app-runtime-base:main-2.3.1

# Commit-specific image
docker pull registry.atlan.com/public/app-runtime-base:sha-49c027f

[!NOTE] The old image name registry.atlan.com/public/application-sdk is deprecated but still published for backward compatibility. New apps should use app-runtime-base.

Contributing

• We welcome contributions! Please see our Contributing Guide for guidelines.

Partner Collaboration

• For information on how to collaborate with Atlan on app development and integrations, please see our Partner Journey Guide.

Need help?

We’re here whenever you need us:

• Issues: GitHub Issues

Security

Have you discovered a vulnerability or have concerns about the SDK? Please read our SECURITY.md document for guidance on responsible disclosure, or please e-mail [e-mail] and we will respond promptly.

License and Attribution

• This project is licensed under the Apache License 2.0 - see the LICENSE file for details.
• This project includes dependencies with various open-source licenses. See the NOTICE file for third-party attributions.