Skip to content

turbinelabs/codec

Repository files navigation

turbinelabs/codec

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

Apache 2.0 GoDoc CircleCI Go Report Card codecov

The codec project provides a simple interface for encoding and decoding values with JSON and YAML implementations, along with a means to configure them with a flag.FlagSet.

Requirements

  • Go 1.10.3 or later (previous versions may work, but we don't build or test against them)

Dependencies

The codec project has no external dependencies; the tests depend on our test package. It should always be safe to use HEAD of all master branches of Turbine Labs open source projects together, or to vendor them with the same git tag.

A gomock-based MockCodec is provided.

Additionally, we vendor github.com/ghodss/yaml. This should be considered an opaque implementation detail, see Vendoring for more discussion.

Install

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

Clone/Test

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

Godoc

codec

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.