https://github.com/clarify/clarify-go
Go(lang) SDK for connecting to https://clarify.io
https://github.com/clarify/clarify-go
Last synced: 9 months ago
JSON representation
Go(lang) SDK for connecting to https://clarify.io
- Host: GitHub
- URL: https://github.com/clarify/clarify-go
- Owner: clarify
- License: apache-2.0
- Created: 2022-03-04T14:10:42.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-08-08T11:56:56.000Z (11 months ago)
- Last Synced: 2025-08-17T18:56:30.226Z (10 months ago)
- Language: Go
- Size: 203 KB
- Stars: 4
- Watchers: 4
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Clarify Go SDK
[](https://github.com/clarify/clarify-go/actions/workflows/go.yml?query=workflow%3AGo+branch%3Amain)
[](https://pkg.go.dev/github.com/clarify/clarify-go)
[][docs]
This repository contains a Go(lang) SDK from [Clarify][clarify]. Clarify is a cloud service for active collaboration on time-series data. It includes a free plan to get started, a plan for small businesses as well as an Enterprise plan for our most demanding customers. If you are interested in SDKs for a different language, or perhaps a different way of integration altogether, please check our [documentation][docs].
## Risk of breaking changes
This SDK is following [Semantic Versioning][semver]. The SDK is currently in a v0 state, which means that we reserver the right to introduce breaking changes without increasing the MAJOR number.
## Features
This SDK is currently written for [Clarify API v1.1][docs-v1.1], and include the following features, based on your integration access configuration:
Always possible:
- Compose Clarify data frames using the `data` sub-package.
- Write signal meta-data to Clarify with `client.SaveSignals` (scoped to the current integration). See [examples/save_signals](examples/save_signals/).
- Write data frames to Clarify with `client.Insert` (scoped to the current integration). See [examples/insert](examples/insert/).
When access to the Admin namespace is granted in Clarify ` (scoped to entire organization):
- Read signal meta-data to Clarify with `client.Admin().SelectSignals`. Allows side-loading related items. See [examples/select_signals](examples/select_signals/).
- Publish signals as items directly with `client.Admin().PublishSignals`, or more conveniently via the `automation` package. See [examples/publish_signals](examples/publish_signals/) for the latter.
When access to the Clarify namespace is granted in Clarify (scoped to entire organization):
- Read item meta-data from Clarify via `client.Clarify().SelectItems`. See [examples/select_items](examples/select_items/).
- Read time-series data from Clarify via `client.Clarify().DataFrame`. See [examples/data_frame](examples/select_items/).
- Do calculations with data from Clarify via `client.Clarify().Evaluate`. See [examples/evaluate](examples/evaluate/).
[clarify]: https://clarify.io/
[semver]: https://semver.org/
[docs]: https://docs.clarify.io
[docs-v1.1]: https://docs.clarify.io/1.1
## Setting up automation routines
By using our [automation](automation) and [automationcli](automation/automationcli) packages, you can quickly define a tree-structure of _Routines_ that can be recognized and run by path-name. See the [automation_cli](examples/automation_cli/) example, or fork our [automation template repository](https://github.com/clarify/template-clarify-automation) to get started. This template let's you customize and build your own automation CLI and easily run it inside GitHub Actions; no external hosting environment is required (unless you want to).
## Copyright
Copyright 2022-2024 Searis AS
Licensed under the Apache License, Version 2.0 (the "License");
you may not use the content in this repo except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.