A unified SDK to interact with our Otter Space Postgres
Go to file
soxx 8ea3369744 docs(postgres): added all the sonarqube badges
Signed-off-by: soxx <soxx@fenpa.ws>
2024-06-24 22:18:34 +02:00
.gitea/workflows ci(postgres): fixed trigger 2024-06-24 12:02:39 +02:00
internal test(postgres): added more tests and some fixes 2024-06-24 22:07:34 +02:00
pkg test(postgres): added more tests and some fixes 2024-06-24 22:07:34 +02:00
test test(postgres): added more tests and some fixes 2024-06-24 22:07:34 +02:00
.gitignore fix: ignore main.go files 2024-05-15 11:17:27 +02:00
go.mod test(postgres): added first tests and already fixed bugs 2024-06-19 23:32:42 +02:00
go.sum test(postgres): added first tests and already fixed bugs 2024-06-19 23:32:42 +02:00
README.md docs(postgres): added all the sonarqube badges 2024-06-24 22:18:34 +02:00

OtterSpace SDK

Bugs Code Smells Coverage Duplicated Lines (%) Lines of Code Maintainability Rating Quality Gate Status Reliability Rating Security Hotspots Security Rating Technical Debt Vulnerabilities

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:

go get git.dragse.it/anthrove/otter-space-sdk

Usage

Here's a simple usage example:

package main

import (
	"context"
	"fmt"
	"git.dragse.it/anthrove/otter-space-sdk/pkg/database"
	"git.dragse.it/anthrove/otter-space-sdk/pkg/models"
)

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
	}
	// 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.