Derek McGowan b22c6b7a4e Update vendor directory to match expectation of vndr tool

Adds READMEs and enforces vendor is done at repository root

Signed-off-by: Derek McGowan <derek@mcgstyle.net>

2017-04-10 12:07:32 -07:00

2.5 KiB

Raw Blame History

News

We are putting together plans for future changes. We obviously depend on all of you to take part in the planning for the future of goamz and execution of the plans. Other than the regulare 'issues' and 'pull requests' please also have a look at TODO.md.

It is inevitable that there will be backward-incompatible changes. Please subscribe to the google group to get all the news (it will only be used for announcements, all the technical discussions will happen on github).

Google group: https://groups.google.com/forum/#!forum/goamz-announcements

GoAMZ

The goamz package enables Go programs to interact with Amazon Web Services.

This is a fork of the version developed within Canonical with additional functionality and services from a number of contributors!

The API of AWS is very comprehensive, though, and goamz doesn't even scratch the surface of it. That said, it's fairly well tested, and is the foundation in which further calls can easily be integrated. We'll continue extending the API as necessary - Pull Requests are very welcome!

The following packages are available at the moment:

github.com/docker/goamz/aws
github.com/docker/goamz/cloudwatch
github.com/docker/goamz/dynamodb
github.com/docker/goamz/ec2
github.com/docker/goamz/elb
github.com/docker/goamz/iam
github.com/docker/goamz/kinesis
github.com/docker/goamz/s3
github.com/docker/goamz/sqs
github.com/docker/goamz/sns

github.com/docker/goamz/exp/mturk
github.com/docker/goamz/exp/sdb
github.com/docker/goamz/exp/ses

Packages under exp/ are still in an experimental or unfinished/unpolished state.

API documentation

The API documentation is currently available at:

http://godoc.org/github.com/docker/goamz

How to build and install goamz

Just use go get with any of the available packages. For example:

$ go get github.com/docker/goamz/ec2
$ go get github.com/docker/goamz/s3

Running tests

To run tests, first install gocheck with:

$ go get launchpad.net/gocheck

Then run go test as usual:

$ go test github.com/docker/goamz/...

Note: running all tests with the command go test ./... will currently fail as tests do not tear down their HTTP listeners.

If you want to run integration tests (costs money), set up the EC2 environment variables as usual, and run:

$ gotest -i

2.5 KiB Raw Blame History