Atlan Application SDK is a Python library for developing applications on the Atlan Platform
Project description
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
[!NOTE] Push-to-
mainCI 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
- 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
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file atlan_application_sdk-3.20.0.tar.gz.
File metadata
- Download URL: atlan_application_sdk-3.20.0.tar.gz
- Upload date:
- Size: 3.7 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.24 {"installer":{"name":"uv","version":"0.11.24","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}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
311cba51b17d984ddb469a691ca5f32e41ae805f0f2511a2ff8fa669295c858f
|
|
| MD5 |
257382e820020697863ea452951b4a30
|
|
| BLAKE2b-256 |
9585e7210d70421741878ef0e05ef168959357f6024705f010f10b0bf9b34e3f
|
File details
Details for the file atlan_application_sdk-3.20.0-py3-none-any.whl.
File metadata
- Download URL: atlan_application_sdk-3.20.0-py3-none-any.whl
- Upload date:
- Size: 855.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.24 {"installer":{"name":"uv","version":"0.11.24","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}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
005f01d1464e87238c152aed3dfcbb5c90b2e5cca51833bd8cb6b22666490eef
|
|
| MD5 |
641b2de6bde053b41b33c980a3624bfa
|
|
| BLAKE2b-256 |
46e51303ad64bad6f7ac7bb82cff5b334faf7da26307337b101b5d89d6ae0766
|
