otter-space-sdk/README.md
SoXX 2391bad68e
All checks were successful
Gitea Build Check / Build (push) Successful in 2m33s
feat(version): updated to version 4
2024-08-29 15:02:39 +02:00

3.8 KiB

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.anthrove.art/Anthrove/otter-space-sdk/v4

Usage

Here's a simple usage example:

package main

import (
	"context"

	"git.anthrove.art/Anthrove/otter-space-sdk/v4/pkg/database"
	"git.anthrove.art/Anthrove/otter-space-sdk/v4/pkg/models"
)

func main() {
	ctx := context.Background()
	var err error

	config := models.DatabaseConfig{
		Endpoint: "",
		Username: "",
		Password: "",
		Database: "",
		Port:     5432,
		SSL:      false,
		Timezone: "Europe/Berlin",
		Debug:    false,
	}

	err = database.Connect(ctx, config)
	if err != nil {
		panic(err)
	}

}

This example creates a new client, connects to the OtterSpace API, and then the client can be used to interact with the API.