Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FT-585: Added Installation for development section to README.md #75

Merged
merged 4 commits into from
Jan 16, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
ATLAN_BASE_URL=your_tenant_base_url
ATLAN_API_KEY=your_api_key
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,4 @@

# Go workspace file
go.work
.env
60 changes: 60 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,65 @@
# Atlan Go SDK
This repository houses the code for a Go SDK to interact with [Atlan](https://atlan.com).


## 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](https://developer.atlan.com/getting-started/#go):

1. Clone the repository:
```bash
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:
```bash
go version
```

3. Install dependencies:
```bash
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:
```bash
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:
```bash
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:
```bash
export $(cat .env | xargs)
```
- For Windows (PowerShell):
```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:
```bash
go test -v ./...
```

---

License: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/),
Copyright 2022 Atlan Pte. Ltd.
Loading