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.
otter-space-sdk/README.md
soxx df14171bad
Some checks failed
Gitea Build Check / Build (push) Has been cancelled
docs(postgres): added all the sonarqube badges
Signed-off-by: soxx <soxx@fenpa.ws>
2024-06-24 22:29:01 +02:00

3.9 KiB

OtterSpace SDK

ALL THE BADGES GIT

Build Check Runner

ALL THE BADGES SONARQUBE

Bugs Code Smells Coverage Duplicated Lines (%) Lines of Code Maintainability Rating Quality Gate Status Reliability Rating Security Hotspots Security Rating 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.