Skip to content

getting-started.md

Latest commit

 

History

History
120 lines (83 loc) · 3.91 KB

getting-started.md

File metadata and controls

120 lines (83 loc) · 3.91 KB

Getting Started with Application SDK

This guide will help you get started with Application SDK development. Follow these steps sequentially, skipping any steps you've already completed.

Core Dependencies

The Application SDK requires the following core dependencies:

  • Python 3.11: The runtime environment for the SDK
  • UV: Modern Python package manager and build system for fast, reproducible installations
  • Dapr: Distributed Application Runtime that simplifies microservice development with built-in state management, pub/sub, and more
  • Temporal: Workflow engine that handles complex, long-running processes with built-in reliability

Note

Dapr and Temporal work together to provide a complete platform - Dapr handles microservice communication and state management, while Temporal orchestrates complex workflows and ensures their reliability.

Step 1: Set Up Development Environment

Tip

If you already have Python 3.11, UV, Dapr, and Temporal installed, you can skip to Step 2.

Choose your platform-specific setup guide to install all required dependencies:

Step 2: Set Up Your First Application

After setting up your development environment, you can create your first application using the Atlan Application SDK.

  1. Clone the sample application repository:

    The Atlan team provides sample applications to help you get started quickly. Clone the repository to your local machine:

    git clone https://github.com/atlanhq/atlan-sample-apps.git
cd atlan-sample-apps

  2. Navigate to the sample application directory:

    cd quickstart/hello_world  # or any other app directory

Step 3: Run Your First Application

Setting Up Project Dependencies

  1. Install project dependencies:

    uv sync --all-extras --all-groups

  2. Set up pre-commit hooks:

    uv run pre-commit install

  3. Verify Dapr components are present:

    uv run poe download-components

Running the Example

  1. Start the dependencies (in a separate terminal):

    uv run poe start-deps

  2. Run an example application:

    uv run python examples/application_hello_world.py

  3. Navigate to localhost:8233 to see a completed workflow ✨

  4. (optional) once you're done, stop the dependencies if you don't need them anymore:

    uv run poe stop-deps

  5. (optional) run the unit tests:

    uv run coverage run -m pytest --import-mode=importlib --capture=no --log-cli-level=INFO tests/ -v --full-trace --hypothesis-show-statistics

Step 4: Advanced Configuration (Optional)

Note

This step is only needed if you're:

  • Connecting to remote Temporal or Dapr services
  • Need custom configuration for your development environment
  • Setting up production environments

If you need to customize your environment:

  1. Copy the example environment file:

    cp .env.example .env

  2. Configure your environment variables in .env:

    • Set Temporal connection details (for remote Temporal service)
    • Configure Dapr endpoints (for custom Dapr setup)
    • Adjust any other required settings

For detailed configuration options, refer to our Configuration Guide.

Next Steps

After successfully running your first application, explore these resources to learn more: