Anthrove/otter-space-sdk
5
0
Fork 0
Code Issues 3 Pull Requests Actions Projects Releases 13 Activity
otter-space-sdk/README.md

66 lines
3.8 KiB
Markdown
Raw Normal View History

refactor: unified migrations and Tag* ID Changes - unified the migrations - added new IDs for Tag, TagAlias, TagGroup - changed relevant functions to use the given IDs BREAKING-CHANGE: Database needs to be cleared or migrated. Not compatible with Database v5
2025-01-28 13:27:11 +01:00
![Build Check Runner](https://git.anthrove.art/Anthrove/otter-space-sdk/v6/actions/workflows/build_check.yaml/badge.svg)
migration from old git (no git history)
2024-07-19 10:03:35 +02:00
[![Bugs](https://sonarqube.dragse.de/api/project_badges/measure?project=Anthrove---OtterSpace-SDK&metric=bugs&token=sqb_96012ffdd64ce721d7f9c82bfa77aa27a5c1fd38)](https://sonarqube.dragse.de/dashboard?id=Anthrove---OtterSpace-SDK)
[![Code Smells](https://sonarqube.dragse.de/api/project_badges/measure?project=Anthrove---OtterSpace-SDK&metric=code_smells&token=sqb_96012ffdd64ce721d7f9c82bfa77aa27a5c1fd38)](https://sonarqube.dragse.de/dashboard?id=Anthrove---OtterSpace-SDK)
[![Coverage](https://sonarqube.dragse.de/api/project_badges/measure?project=Anthrove---OtterSpace-SDK&metric=coverage&token=sqb_96012ffdd64ce721d7f9c82bfa77aa27a5c1fd38)](https://sonarqube.dragse.de/dashboard?id=Anthrove---OtterSpace-SDK)
[![Duplicated Lines (%)](https://sonarqube.dragse.de/api/project_badges/measure?project=Anthrove---OtterSpace-SDK&metric=duplicated_lines_density&token=sqb_96012ffdd64ce721d7f9c82bfa77aa27a5c1fd38)](https://sonarqube.dragse.de/dashboard?id=Anthrove---OtterSpace-SDK)
[![Lines of Code](https://sonarqube.dragse.de/api/project_badges/measure?project=Anthrove---OtterSpace-SDK&metric=ncloc&token=sqb_96012ffdd64ce721d7f9c82bfa77aa27a5c1fd38)](https://sonarqube.dragse.de/dashboard?id=Anthrove---OtterSpace-SDK)
[![Maintainability Rating](https://sonarqube.dragse.de/api/project_badges/measure?project=Anthrove---OtterSpace-SDK&metric=sqale_rating&token=sqb_96012ffdd64ce721d7f9c82bfa77aa27a5c1fd38)](https://sonarqube.dragse.de/dashboard?id=Anthrove---OtterSpace-SDK)
[![Quality Gate Status](https://sonarqube.dragse.de/api/project_badges/measure?project=Anthrove---OtterSpace-SDK&metric=alert_status&token=sqb_96012ffdd64ce721d7f9c82bfa77aa27a5c1fd38)](https://sonarqube.dragse.de/dashboard?id=Anthrove---OtterSpace-SDK)
[![Reliability Rating](https://sonarqube.dragse.de/api/project_badges/measure?project=Anthrove---OtterSpace-SDK&metric=reliability_rating&token=sqb_96012ffdd64ce721d7f9c82bfa77aa27a5c1fd38)](https://sonarqube.dragse.de/dashboard?id=Anthrove---OtterSpace-SDK)
[![Security Hotspots](https://sonarqube.dragse.de/api/project_badges/measure?project=Anthrove---OtterSpace-SDK&metric=security_hotspots&token=sqb_96012ffdd64ce721d7f9c82bfa77aa27a5c1fd38)](https://sonarqube.dragse.de/dashboard?id=Anthrove---OtterSpace-SDK)
[![Security Rating](https://sonarqube.dragse.de/api/project_badges/measure?project=Anthrove---OtterSpace-SDK&metric=security_rating&token=sqb_96012ffdd64ce721d7f9c82bfa77aa27a5c1fd38)](https://sonarqube.dragse.de/dashboard?id=Anthrove---OtterSpace-SDK)
[![Vulnerabilities](https://sonarqube.dragse.de/api/project_badges/measure?project=Anthrove---OtterSpace-SDK&metric=vulnerabilities&token=sqb_96012ffdd64ce721d7f9c82bfa77aa27a5c1fd38)](https://sonarqube.dragse.de/dashboard?id=Anthrove---OtterSpace-SDK)
# 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`:
```shell
refactor: unified migrations and Tag* ID Changes - unified the migrations - added new IDs for Tag, TagAlias, TagGroup - changed relevant functions to use the given IDs BREAKING-CHANGE: Database needs to be cleared or migrated. Not compatible with Database v5
2025-01-28 13:27:11 +01:00
go get git.anthrove.art/Anthrove/otter-space-sdk/v6
migration from old git (no git history)
2024-07-19 10:03:35 +02:00
````
## Usage
Here's a simple usage example:
```go
package main
import (
"context"
refactor: unified migrations and Tag* ID Changes - unified the migrations - added new IDs for Tag, TagAlias, TagGroup - changed relevant functions to use the given IDs BREAKING-CHANGE: Database needs to be cleared or migrated. Not compatible with Database v5
2025-01-28 13:27:11 +01:00
"git.anthrove.art/Anthrove/otter-space-sdk/v6/pkg/database"
"git.anthrove.art/Anthrove/otter-space-sdk/v6/pkg/models"
migration from old git (no git history)
2024-07-19 10:03:35 +02:00
)
func main() {
chore(readme): Update README example to include full DatabaseConfig initialization and use database.Connect function
2024-08-14 15:03:26 +02:00
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)
migration from old git (no git history)
2024-07-19 10:03:35 +02:00
if err != nil {
chore(readme): Update README example to include full DatabaseConfig initialization and use database.Connect function
2024-08-14 15:03:26 +02:00
panic(err)
migration from old git (no git history)
2024-07-19 10:03:35 +02:00
}
chore(readme): Update README example to include full DatabaseConfig initialization and use database.Connect function
2024-08-14 15:03:26 +02:00
migration from old git (no git history)
2024-07-19 10:03:35 +02:00
}
chore(readme): Update README example to include full DatabaseConfig initialization and use database.Connect function
2024-08-14 15:03:26 +02:00
migration from old git (no git history)
2024-07-19 10:03:35 +02:00
```
This example creates a new client, connects to the OtterSpace API, and then the client can be used to interact with the API.
Reference in New Issue Copy Permalink