A unified SDK to interact with our Otter Space Postgres
This repository has been archived on 2024-07-22. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
SoXX a39cfd2027
Some checks failed
Gitea Build Check / Build (push) Failing after 6m26s
Merge pull request 'BREAKING CHANGE: V2 of thr SDK' (#12) from develop/postgresql into main
Reviewed-on: #12
Reviewed-by: Lennard Brinkhaus <lennard.brinkhaus@noreply.localhost>
2024-07-01 20:46:26 +00:00
.gitea/workflows Merge pull request 'BREAKING CHANGE: V2 of thr SDK' (#12) from develop/postgresql into main 2024-07-01 20:46:26 +00:00
internal fix: fixed function to work properly 2024-07-01 22:40:53 +02:00
pkg fix: fixed function to work properly 2024-07-01 22:40:53 +02:00
test tests: fixed tests 2024-06-28 14:16:28 +02:00
.gitignore fix: ignore main.go files 2024-05-15 11:17:27 +02:00
go.mod feat(postgres): updated go mod 2024-06-25 15:09:39 +02:00
go.sum feat(postgres): updated go mod 2024-06-25 15:09:39 +02:00
README.md docs(postgres): rearranged 2024-06-24 22:30:57 +02:00

Build Check Runner Bugs Code Smells Coverage

Duplicated Lines (%) Lines of Code Maintainability Rating Quality Gate Status

Reliability Rating Security Hotspots Security Rating Vulnerabilities

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:

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.