Home

Awesome

turbinelabs/api

This project is no longer maintained by Turbine Labs, which has shut down.

Apache 2.0 GoDoc CircleCI Go Report Card codecov

The api project provides Go bindings for the Turbine Labs public API. We use these bindings in both our open-sourced projects and our private server implementations; as such this project represents the source of truth for how our public API is defined.

We also provide a swagger definition, which backs our API documentation and may be used to generate additional clients in the future.

Requirements

Dependencies

The api project depends on the nonstdlib package. The tests depend on our test package, and on gomock, and gomock-based Mocks of most interfaces are provided.

Install

go get -u github.com/turbinelabs/api/...

Clone/Test

mkdir -p $GOPATH/src/turbinelabs
git clone https://github.com/turbinelabs/api.git > $GOPATH/src/turbinelabs/api
go test github.com/turbinelabs/api/...

Godoc

api

Versioning

Please see Versioning of Turbine Labs Open Source Projects.

Pull Requests

Patches accepted! Please see Contributing to Turbine Labs Open Source Projects.

Code of Conduct

All Turbine Labs open-sourced projects are released with a Contributor Code of Conduct. By participating in our projects you agree to abide by its terms, which will be carefully enforced.