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

This version

3.5.0

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.5.0.tar.gz (2.0 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.5.0-py3-none-any.whl (588.6 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for atlan_application_sdk-3.5.0.tar.gz
Algorithm Hash digest
SHA256 a65f3da34ed94af8550cabf9fa6c1e74b72cb78ea0e157fc9fcbf1602b6e2f1d
MD5 10353381cc82dd95400c964e55df8097
BLAKE2b-256 72ddee5760a8505364396806a3ae55b34efebe633da469a8289ccc1566e0e271

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atlan_application_sdk-3.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8e38fe8af5b19c015d7fab13b63a20754fee76636a2253fcd309d95e9f630969
MD5 26c376231289ebc4f35ede1037adfaf4
BLAKE2b-256 043363e8a808bcf169c5392d1eab6b431b5816240866271f314d46f96462702d

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