bindle

README

Go Bindle Client

A Bindle client for Go.

Using the Client

Below is a simple example using the client to get an invoice

package main

import (
    "fmt"

    "github.com/deislabs/go-bindle/client"
)

func main() {
    // The second parameter takes an optional tls.Config if you have any special TLS configuration 
    // needs. A nil config will just use the default
    bindleClient, err := client.New("https://my.bindle.server.com/v1", nil)
    if err != nil {
        panic(err)
    }

    invoice, err := bindleClient.GetInvoice("example.com/foo/1.0.0")
    if err != nil {
        panic(err)
    }

    fmt.Println(invoice)
}

Please visit the documentation for more information on each of the functions

Contributing

We welcome any contributions or feedback! If you'd like to contribute code, please open a Pull Request.

This project has adopted the Microsoft Open Source Code of Conduct.

For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Tests

Testing for the client is mostly done with integration tests. In order to run the integration tests, you'll need a bindle-server binary available for the tests to use. By default, the tests will search in your $PATH for an executable called bindle-server. You can also configure it to use a specific binary by setting the BINDLE_SERVER_PATH environment variable. Currently the testing pipeline uses the canary bindle-server for testing and will continue to do so until the spec and project have stabilized

Documentation

Overview

Package bindle contains a Bindle client, types, and other utilities for interacting with a Bindle server. For more information on Bindle, see the main project page: https://github.com/deislabs/bindle. There is nothing exported at this top level, but each subpackage contains more information on its functionality