Skip to content

"Golang SDK Public because it allows external contribution and provides code samples that all should be able to see, and also houses a public-facing, open source SDK that's intended for external consumption."

License

Notifications You must be signed in to change notification settings

atlanhq/atlan-go

This branch is up to date with main.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

4eed4cf · Feb 19, 2025
Jan 23, 2025
Feb 19, 2025
Jan 30, 2025
Jan 16, 2025
Jan 23, 2025
Jan 23, 2025
Apr 16, 2024
Apr 16, 2024
Jan 16, 2025
Apr 16, 2024
Jul 9, 2024
Jul 9, 2024
Feb 19, 2025

Repository files navigation

Atlan Go SDK Logo

Atlan Go SDK

This repository houses the code for a Go SDK to interact with Atlan.

Installing for Development

Initial Setup

To get started developing or using the SDK, follow the steps below. For a more detailed overview, check out our Getting Started Guide:

  1. Clone the repository:

    git clone https://github.com/atlanhq/atlan-go.git
  2. Ensure you have Go 1.19 or later installed. You can verify your Go version with:

    go version
  3. Install dependencies:

    go mod tidy

Code Formatting

Ensure your code adheres to the repository's formatting guidelines before committing. You can use the following command to format the code:

go fmt ./...

Environment Setup

To run integration tests or interact with the Atlan API, you'll need to configure your environment:

  1. Copy the example environment file:

    cp .env.example .env
  2. Update the .env file with your Atlan API key and base URL.

  3. Load the environment variables:

    • For macOS/Linux:
      export $(cat .env | xargs)
    • For Windows (PowerShell):
      Get-Content .env | ForEach-Object {
          if ($_ -match '^(.*?)=(.*)$') {
              $env:($matches[1]) = $matches[2]
          }
      }

Testing the SDK

You can run all tests in local development with the following command:

go test -v ./...

License: CC BY 4.0, Copyright 2022 Atlan Pte. Ltd.

About

"Golang SDK Public because it allows external contribution and provides code samples that all should be able to see, and also houses a public-facing, open source SDK that's intended for external consumption."

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages