SoXX
44bedd20a1
Updated the module to version 3. BREAKING CHANGE: This SDK version is not compatible with programs using the v2 implementation.
56 lines
3.7 KiB
Markdown
56 lines
3.7 KiB
Markdown
|
|
[](https://sonarqube.dragse.de/dashboard?id=Anthrove---OtterSpace-SDK)
|
|
[](https://sonarqube.dragse.de/dashboard?id=Anthrove---OtterSpace-SDK)
|
|
[](https://sonarqube.dragse.de/dashboard?id=Anthrove---OtterSpace-SDK)
|
|
|
|
[](https://sonarqube.dragse.de/dashboard?id=Anthrove---OtterSpace-SDK)
|
|
[](https://sonarqube.dragse.de/dashboard?id=Anthrove---OtterSpace-SDK)
|
|
[](https://sonarqube.dragse.de/dashboard?id=Anthrove---OtterSpace-SDK)
|
|
[](https://sonarqube.dragse.de/dashboard?id=Anthrove---OtterSpace-SDK)
|
|
|
|
[](https://sonarqube.dragse.de/dashboard?id=Anthrove---OtterSpace-SDK)
|
|
[](https://sonarqube.dragse.de/dashboard?id=Anthrove---OtterSpace-SDK)
|
|
[](https://sonarqube.dragse.de/dashboard?id=Anthrove---OtterSpace-SDK)
|
|
[](https://sonarqube.dragse.de/dashboard?id=Anthrove---OtterSpace-SDK)
|
|
|
|
# OtterSpace SDK
|
|
|
|
The OtterSpace SDK is a Go package for interacting with the OtterSpace API. It provides methods for connecting to the API, adding and linking users, posts, and sources, and retrieving information about users and posts.
|
|
|
|
## Installation
|
|
|
|
To install the OtterSpace SDK, you can use `go get`:
|
|
|
|
```shell
|
|
go get git.anthrove.art/Anthrove/otter-space-sdk/v3
|
|
````
|
|
## Usage
|
|
|
|
Here's a simple usage example:
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"context"
|
|
"log"
|
|
|
|
"git.anthrove.art/Anthrove/otter-space-sdk/v3/pkg/database"
|
|
"git.anthrove.art/Anthrove/otter-space-sdk/v3/pkg/models"
|
|
)
|
|
|
|
func main() {
|
|
ctx := context.Background()
|
|
cfg := models.DatabaseConfig{}
|
|
|
|
pgClient := database.NewPostgresqlConnection()
|
|
err := pgClient.Connect(ctx, cfg)
|
|
if err != nil {
|
|
log.Panic(err)
|
|
}
|
|
|
|
}
|
|
```
|
|
|
|
This example creates a new client, connects to the OtterSpace API, and then the client can be used to interact with the API.
|