Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ovotech/go-sync
Go library for synchronising all the things
https://github.com/ovotech/go-sync
company-ovo
Last synced: 12 days ago
JSON representation
Go library for synchronising all the things
- Host: GitHub
- URL: https://github.com/ovotech/go-sync
- Owner: ovotech
- License: apache-2.0
- Created: 2022-09-09T09:31:57.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-22T11:16:48.000Z (8 months ago)
- Last Synced: 2024-04-22T12:33:00.939Z (8 months ago)
- Topics: company-ovo
- Language: Go
- Homepage:
- Size: 1.26 MB
- Stars: 10
- Watchers: 2
- Forks: 4
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
| **⚠️ Go Sync is under active development and subject to breaking changes.** |
|-----------------------------------------------------------------------------|
# Go Sync (all the things)
[](go.mod)
[](https://github.com/ovotech/go-sync/releases)
[](https://goreportcard.com/report/github.com/ovotech/go-sync)
[](https://pkg.go.dev/github.com/ovotech/go-sync)
[](https://github.com/ovotech/go-sync/actions/workflows/test.yml)
[](https://github.com/ovotech/go-sync/issues)
[](https://github.com/ovotech/go-sync/pull-requests)
[](/LICENSE)
You have people*. You have places you want them to be. Go Sync makes it happen.
_* Doesn't have to be people._
## Installation
```shell
go get github.com/ovotech/go-sync@latest
# Then get the adapters you need.
go get github.com/ovotech/go-sync/adapters/slack@latest
```
You're ready to Go Sync! 🎉
## Usage
Read the [documentation on `pkg.go.dev`](https://pkg.go.dev/github.com/ovotech/go-sync).
Go Sync consists of two fundamental parts:
1. [Sync](#sync-)
2. [Adapters](#adapters-)
As long as your adapters are compatible, you can synchronise anything.
```go
// Create an adapter using the recommended method.
client := service.New("some-token")
source := myAdapter.New(client, "some-value")
// Initialise an adapter using an Init function.
destination, err := myAdapter.Init(map[gosync.ConfigKey]string{
myAdapter.Token: "some-token",
myAdapter.Something: "some-value",
})
if err != nil {
log.Fatal(err)
}
sync := gosync.New(source)
err := sync.SyncWith(context.Background(), destination)
if err != nil {
log.Fatal(err)
}
```
### Init
While we recommend using `New` to create an adapter in most cases, some plugins may provide an `Init` function for
instantiating them too. Init functions are intended for programmatically creating adapters either via environment
variables or some other dynamic configuration.
## Sync 🔄
Sync is the logic that powers the automation. It accepts a source adapter, and synchronises it with destination
adapters.
Sync is only uni-directional by design. You know where your things are, and where you want them to be. It works by:
1. Get a list of things in your source service.
1. Cache it, so you're not calling your source service more than you have to.
2. Get a list of things in your destination service.
3. Add the things that are missing.
4. Remove the things that shouldn't be there.
5. Repeat from 2 for further adapters.
## [Adapters](./adapters) 🔌
Adapters provide a common interface to services.
Adapters must implement our [Adapter interface](https://pkg.go.dev/github.com/ovotech/go-sync#Adapter) and functionally
perform 3 things:
1. Get the things.
2. Add some things.
3. Remove some things.
These things can be anything, but we recommend email addresses. There's no point trying to sync a Slack User ID with a
GitHub user! 🙅
Can't find an adapter you're looking for? [Why not write your own! ✨](/CONTRIBUTING.md)
### Made with 💚 by OVO Energy's DevEx team
