otter-space-sdk/README.md

49 lines
1.2 KiB
Markdown

# 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.dragse.it/anthrove/otter-space-sdk
````
## Usage
Here's a simple usage example:
```go
package main
import (
"context"
"fmt"
"git.dragse.it/anthrove/otter-space-sdk/pkg/models"
"git.dragse.it/anthrove/otter-space-sdk/pkg/database"
)
func main() {
var err error
dbDebug := false
ctx := context.Background()
pgClient := database.NewPostgresqlConnection(dbDebug)
err = pgClient.Connect(ctx, "your-endpoint", "your-username", "your-password", "anthrove", 5432, "disable", "Europe/Berlin")
if err != nil {
fmt.Println(err)
return
}
graphClient := database.NewGraphConnection(dbDebug)
err = graphClient.Connect(ctx, "your-endpoint", "your-username", "your-password", "NOT USED",0,"NOT USED","NOT USED")
if err != nil {
fmt.Println(err)
return
}
// further usage of the client...
}
```
This example creates a new client, connects to the OtterSpace API, and then the client can be used to interact with the API.