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 a9146fb6ab
All checks were successful
Gitea Build Check / Build (push) Successful in 11m41s
Merge pull request 'develop/batch-jobs' (#13) from develop/batch-jobs into main
Reviewed-on: #13
2024-07-06 21:49:24 +00:00
.gitea/workflows Update .gitea/workflows/ build_check.yaml 2024-07-02 06:20:34 +00:00
internal feat: finalized functions with tests 2024-07-06 22:19:55 +02:00
pkg test: fixed wong test 2024-07-06 23:32:43 +02:00
test feat: fixed module path to v2 2024-07-02 10:11:42 +02:00
.gitignore fix: ignore main.go files 2024-05-15 11:17:27 +02:00
go.mod feat: fixed module path to v2 2024-07-02 10:11:42 +02:00
go.sum feat: fixed module path to v2 2024-07-02 10:11:42 +02:00
README.md feat: fixed module path to v2 2024-07-02 10:11:42 +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/v2

Usage

Here's a simple usage example:

package main

import (
	"context"
	"fmt"

	"git.dragse.it/anthrove/otter-space-sdk/v2/pkg/database"
	"git.dragse.it/anthrove/otter-space-sdk/v2/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.