Metadata-Version: 2.3
Name: atlan-application-sdk
Version: 0.1.1rc3
Summary: Python Application SDK is a Python library for developing applications on the Atlan Platform
License: Apache-2.0
Keywords: atlan,sdk,platform,app,development
Author: Atlan App Team
Author-email: connect@atlan.com
Requires-Python: >=3.11,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Provides-Extra: daft
Provides-Extra: iam-auth
Provides-Extra: iceberg
Provides-Extra: scale-data-generator
Provides-Extra: sqlalchemy
Provides-Extra: tests
Provides-Extra: workflows
Requires-Dist: boto3 (>=1.38.6,<2.0.0) ; extra == "iam-auth"
Requires-Dist: dapr (>=1.14.0,<2.0.0) ; extra == "workflows"
Requires-Dist: duckdb (>=1.1.3,<2.0.0) ; extra == "scale-data-generator"
Requires-Dist: duckdb-engine (>=0.17.0,<0.18.0) ; extra == "scale-data-generator"
Requires-Dist: faker (>=37.1.0,<38.0.0) ; extra == "scale-data-generator"
Requires-Dist: fastapi[standard] (>=0.115.0,<0.116.0)
Requires-Dist: getdaft[sql] (>=0.4.12,<0.5.0) ; extra == "daft"
Requires-Dist: loguru (>=0.7.3,<0.8.0)
Requires-Dist: numpy (>=1.23.5,<3.0.0) ; extra == "scale-data-generator"
Requires-Dist: opentelemetry-exporter-otlp (>=1.27.0,<2.0.0)
Requires-Dist: orjson (>=3.10.18,<4.0.0) ; extra == "workflows"
Requires-Dist: pandas (>=2.2.3,<3.0.0) ; extra == "tests" or extra == "scale-data-generator"
Requires-Dist: pandera[io] (>=0.23.1,<0.24.0) ; extra == "tests"
Requires-Dist: psutil (>=7.0.0,<8.0.0)
Requires-Dist: pyarrow (>=20.0.0,<21.0.0) ; extra == "scale-data-generator"
Requires-Dist: pyatlan (==6.0.6)
Requires-Dist: pydantic (>=2.10.6,<3.0.0)
Requires-Dist: pyiceberg (>=0.8.1,<0.9.0) ; extra == "iceberg"
Requires-Dist: pytest-order (>=1.3.0,<2.0.0) ; extra == "tests"
Requires-Dist: python-dotenv (>=1.1.0,<2.0.0)
Requires-Dist: pyyaml (>=6.0.2,<7.0.0) ; extra == "scale-data-generator"
Requires-Dist: sqlalchemy[asyncio] (>=2.0.36,<3.0.0) ; extra == "sqlalchemy"
Requires-Dist: temporalio (>=1.7.1,<2.0.0) ; extra == "workflows"
Requires-Dist: uvloop (>=0.21.0,<0.22.0)
Project-URL: Documentation, https://github.com/atlanhq/application-sdk/README.md
Project-URL: Repository, https://github.com/atlanhq/application-sdk
Description-Content-Type: text/markdown

# Atlan Application SDK
[![On-Push Checks](https://github.com/atlanhq/application-sdk/actions/workflows/push.yaml/badge.svg)](https://github.com/atlanhq/application-sdk/actions/workflows/push.yaml) [![CodeQL Advanced](https://github.com/atlanhq/application-sdk/actions/workflows/codeql.yaml/badge.svg)](https://github.com/atlanhq/application-sdk/actions/workflows/codeql.yaml) [![PyPI version](https://img.shields.io/pypi/v/atlan-application-sdk.svg)](https://pypi.org/project/atlan-application-sdk/)

Application SDK is a Python library for developing applications on the Atlan Platform. It provides a comprehensive PaaS (Platform as a Service) system with tools and services to build, test, and manage applications.

## Getting Started

To begin developing with the Application SDK:

1. Clone the repository
2. Follow the setup instructions for your platform:
   - [Windows](./docs/docs/setup/WINDOWS.md)
   - [Mac](./docs/docs/setup/MAC.md)
   - [Linux](./docs/docs/setup/LINUX.md)
3. Run the example application:
   - [Hello World](./examples/application_hello_world.py)
   - [SQL](./examples/application_sql.py)

## Documentation

- Detailed documentation for the application-sdk is available at [k.atlan.dev/application-sdk/main](https://k.atlan.dev/application-sdk/main).
- If you are not able to access the URL, you can check the docs in the [docs](./docs) folder.

## Usage

### Example Applications

- View a production-grade SQL application built using application-sdk [here](https://github.com/atlanhq/atlan-postgres-app)
- View sample apps built using application-sdk [here](https://github.com/atlanhq/atlan-sample-apps)

### Installation

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

- Using pip:
```bash
# pip install the latest version from PyPI
pip install atlan-application-sdk
```

- Using alternative package managers:
```bash
# Using uv to install the latest version from PyPI
uv pip install atlan-application-sdk

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

## Contributing

We welcome contributions! Please see our [Contributing Guide](./CONTRIBUTING.md) for guidelines.

## Need Help?

Get support through any of these channels:

- Email: **connect@atlan.com**
- Slack: **#pod-app-framework**
- Issues: [GitHub Issues](https://github.com/atlanhq/application-sdk/issues)

## Security

Have you discovered a vulnerability or have concerns about the SDK? Please read our [SECURITY.md](./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](LICENSE) file for details.

This project includes dependencies with various open-source licenses. See the [NOTICE](NOTICE) file for third-party attributions.

