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 uv (recommended):
uv add atlan-application-sdk
- Using pip:
pip install atlan-application-sdk
[!TIP] Example apps built with the Application SDK:
- Hello World — reference app for tutorial
- OpenAPI Spec Loader — loads assets from an OpenAPI spec into Atlan
- MySQL — MySQL metadata crawler
- Metabase — Metabase metadata crawler
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
Every release also publishes the same digest to GHCR at ghcr.io/atlanhq/app-runtime-base, with the same tag ladder. That mirror exists for Atlan's own app CI — GHCR pulls from GitHub-hosted runners avoid the S3 egress that a Harbor pull incurs — and is byte-identical to the Harbor image for a given tag.
[!NOTE] Use
registry.atlan.com/public/app-runtime-basein app Dockerfiles: it is the reference for external/partner and tenant use. The GHCR mirror above is for internal CI. Separately, push-to-mainbuilds go toghcr.io/atlanhq/app-runtime-base-main:sha-<sha7>(note the-mainsuffix — a different package) and are unversioned dev images, for internal development only.
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 security@atlan.com and we will respond promptly.
License and Attribution
1 maintainer
Metadata
1 maintainer
Release files for atlan-application-sdk 3.31.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| atlan_application_sdk-3.31.0.tar.gz | 7.6 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| atlan_application_sdk-3.31.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 9.2 MB
Release files / atlan_application_sdk-3.31.0.tar.gz
| Download URL | atlan_application_sdk-3.31.0.tar.gz |
|---|---|
| Size | 7.6 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
09236835041ff4988625bde22e7f028d046e07b762a2392330a64d0551efc162
|
|
BLAKE2b-256 checksum How to use checksums |
5bcde2287129cd232712956e710fd7f2f78a8d341e10321392d11ee3796f4986
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.7 {"installer":{"name":"uv","version":"0.12.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / atlan_application_sdk-3.31.0-py3-none-any.whl
| Download URL | atlan_application_sdk-3.31.0-py3-none-any.whl |
|---|---|
| Size | 1.6 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e2bcf91b64046c3046b7ac176158ec5b23ea65b08f238fc336352a4c1ff23173
|
|
BLAKE2b-256 checksum How to use checksums |
45c51c1e75fc9f2ce261a7b21dee9dac617e9960c9332f60cbffbfbd07152a65
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.7 {"installer":{"name":"uv","version":"0.12.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
