Skip to main content

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

Project description

Atlan Application SDK

On-Push Checks CodeQL Advanced PyPI version Ask DeepWiki

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 uv (recommended):
uv add atlan-application-sdk
  • Using pip:
pip install 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.

Images are published to Harbor on every release:

# Major-version alias — tracks the latest v3.x release (recommended for app Dockerfiles)
docker pull registry.atlan.com/public/app-runtime-base:3

# Minor-version alias (always points to the latest patch release)
docker pull registry.atlan.com/public/app-runtime-base:3.3

# Specific version (pinned, fully reproducible)
docker pull registry.atlan.com/public/app-runtime-base:3.3.0

# Immutable commit-pinned tag
docker pull registry.atlan.com/public/app-runtime-base:sha-49c027f

[!NOTE] Push-to-main CI builds are published to GHCR (ghcr.io/atlanhq/app-runtime-base-main:sha-<sha7>) and are intended for internal development use only. Use a versioned Harbor tag for app Dockerfiles.

Contributing

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:

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 security@atlan.com 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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

atlan_application_sdk-3.10.0.tar.gz (2.5 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

atlan_application_sdk-3.10.0-py3-none-any.whl (703.1 kB view details)

Uploaded Python 3

File details

Details for the file atlan_application_sdk-3.10.0.tar.gz.

File metadata

File hashes

Hashes for atlan_application_sdk-3.10.0.tar.gz
Algorithm Hash digest
SHA256 0db8e65435ab72745c4d545ea125936ec7870030944960ab910442474b9c66bf
MD5 69ab39a4da29d608372131d0494ac7ec
BLAKE2b-256 bdc30bfc00218f7dbe9d57a138a84e158a19568f599a81d7520b4bbc3c6ad229

See more details on using hashes here.

File details

Details for the file atlan_application_sdk-3.10.0-py3-none-any.whl.

File metadata

File hashes

Hashes for atlan_application_sdk-3.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d0d1e69be733736cc4d86e295af14503d8652bc01e0d72b1d218134c8c407062
MD5 fec50f830e33fec669a4def97706a43f
BLAKE2b-256 b005c21381479ed1c068dba0d97b61951b2ee2a1a969bc87d3fb93f24f8550b3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page