Skip to main content

Set up your development environment

This lesson helps you set up your local development environment to start building applications with the Application SDK. Think of this as preparing your construction site before you begin building, ensuring you have all the right tools and materials in place.

🎓

What you learn here: How to install and configure the essential tools needed to build Atlan applications. By the end of this lesson, your computer becomes a complete development workspace.

Follow each section in order, and don't worry if something seems unfamiliar. This lesson covers everything step by step.

Core dependencies​

Before you start building, you need essential tools on your computer. Think of these as your construction tools and materials, each one has a specific purpose. Ready to deep dive and learn how these tools help you build:

Understanding your tools​

Python

Python 3.11

The programming language that powers your application. Python lets your computer understand and execute your instructions.

UV

UV

Your package manager that handles all Python dependencies. UV efficiently manages and installs the libraries your application needs.

Dapr

Dapr

A distributed application runtime that helps different parts of your app communicate. Dapr provides building blocks for microservices.

Temporal

Temporal

A workflow orchestration platform that manages long-running tasks. Temporal ensures workflows complete reliably, even through failures.


Now that you understand what each tool does, time to get them installed on your computer. Think of this next step like preparing your construction site - you need each tool and material ready before you can start building.

Install prerequisites​

Before you start building, you need to set up your development tools. Think of this like setting up your construction site—you need all the right tools and utilities connected so you can focus on the actual building process.

Install Git​

Git is a version control system you need to download sample applications and manage your code. Most systems have Git pre-installed, but first verify and install if needed:

  • Check if Git is already installed: Run this command in your terminal:

    git --version

  • If Git isn't installed, download and install it from git-scm.com for your operating system.

Now install the Atlan-specific development tools.

Choose your operation system​

Follow the detailed setup guides for your operating system that walks you through installing everything you need. Take your time with the installation—usually 10-15 minutes depending on your internet connection. Getting this foundation right means you can focus on the fun part: building your first application!

  • macOS: macOS setup guide if you have a Mac computer. The guide walks you through using Homebrew to install everything smoothly.
  • Linux: Linux setup guide if you use Ubuntu, Debian, CentOS, or other Linux systems. You use your system's built-in package manager.
  • Windows: Windows setup guide if you have Windows 10 or Windows 11. The guide shows you how to use PowerShell and download installers.

Once you complete the setup guide for your system, return here to verify everything works properly.

Verify your environment​

Time to check if the Atlan development tools installed correctly. Open your terminal (also called Command Prompt on Windows) and run these commands one by one. You have to verify the version of installed tools, that helps you evaluate 1 - that the tool is installed and 2 - that the correct version is installed. Time to start testing:

  • Open your terminal or command prompt and run the below commands:

    • Check Python first: Once Python is installed, the python3 command becomes available in your terminal. Run the command below to check the version to make sure you have the versionPython 3.11.5 or later.

      python3 --version

    • Check UV next: After installing UV, the uv command becomes available. Check what version you have installed. Any version number means UV is installed and working.

      uv --version

    • Check Dapr: When Dapr installs successfully, it gives you the dapr command. Test the version to confirm everything is working. The minimum required versions are CLI version: 1.12.0 and Runtime version: 1.12.0 or later appearing means Dapr is properly installed.

      dapr --version

    • Check Temporal: After Temporal installation, you get the temporal command (or sometimes tctl for older versions). Test which version you have. Any version number means Temporal is installed.

      temporal --version

      If this doesn't work, try the classic CLI command:

      tctl --version

      Either command showing a version number means Temporal is ready to use.

Something not working?

If any command fails or shows an error, go back to your setup guides for your operating system and follow the troubleshooting section. Don't continue until all commands work properly.

If all four commands completed successfully and showed version numbers, congratulations! Your development environment is ready for building Atlan applications.

🎉

You did it! Setting up a development environment can feel overwhelming, but you completed every step. You are ready to start building real applications.

What's next​

Your computer is now a complete development workspace for building Atlan applications. You have all the tools installed and verified they work together.

In the next lesson, you start working with an example application to understand how these tools work together in practice.

Continue learning​

Ready for the next lesson? Time to run your first sample application → Run sample app with SDK