x/golang-client
Code Issues Proposed changes
OpenStack API client for golang
18 Commits 1 Branch 0 Tags 553 KiB
Go 95.9%
Makefile 2.1%
Shell 2%
03aa5209e0
Go to file
Matt Farina 03aa5209e0 Adding sublime project files to the gitignore. 
Change-Id: Ib9c10ae5c8c5aa90b44a45526ff17290d31e5d9d
2014-10-09 14:46:58 -04:00
examples Merge "Move the service handling to be versioned." 2014-06-11 19:50:07 +00:00
identity/v2 Move the service handling to be versioned. 2014-06-05 14:13:44 -04:00
misc Adding the appropriate license and copyright statements. 2014-05-29 17:09:57 -04:00
objectstorage/v1 Move the service handling to be versioned. 2014-06-05 14:13:44 -04:00
.gitignore Adding sublime project files to the gitignore. 2014-10-09 14:46:58 -04:00
.gitreview Added .gitreview 2013-06-04 14:01:00 +00:00
CONTRIBUTING.md Adding contributions guide. 2014-05-15 14:35:40 -04:00
LICENSE All tests passed. Initial commit. 2013-07-14 21:12:30 +07:00
README.md Updated the test documentation to point to the examples rather 2014-05-29 17:13:18 -04:00

README.md

Golang Client

stackforge/golang-client is yet another implementation of [OpenStack] (http://www.openstack.org/) API client in Go language. The code follows OpenStack licensing and borrows its infrastructure for code hosting. It currently implements [Identity Service v2] (http://docs.openstack.org/api/openstack-identity-service/2.0/content/) and [Object Storage v1] (http://docs.openstack.org/api/openstack-object-storage/1.0/content/). Some API calls are not implemented initially, but the intention is to expand the lib over time (where pragmatic).

Code maturity is considered experimental.

Installation

Use go get git.openstack.org/stackforge/golang-client.git. Or alternatively, download or clone the repository.

The lib was developed and tested on go 1.2. No external dependencies, so far.

Examples

The examples directory contains examples for using the SDK using real world working code. Each example starts with a two digit number followed by a name (e.g., 00-authentication.go). If you have a config.json file in the examples directory following the format of config.json.dist the example can be executed using go run [example name] setup.go. Or, all the examples can be executed running the script run-all.sh from the examples directory.

Testing

There are two types of test files. The *_test.go are standard golang unit test files. The examples can be run as integration tests.

The tests were written against the [OpenStack API specifications] (http://docs.openstack.org/api/api-specs.html). The integration test were successful against the following:

If you use another provider and successfully completed the tests, please email the maintainer(s) so your service can be mentioned here. Alternatively, if you are a service provider and can arrange a free (temporary) account, a quick test can be arranged.

License

Apache v2.

Contributing

The code repository borrows OpenStack StackForge infrastructure. Please use the [recommended workflow] (https://wiki.openstack.org/wiki/GerritWorkflow). If you are not a member yet, please consider joining as an [OpenStack contributor] (https://wiki.openstack.org/wiki/HowToContribute). If you have questions or comments, you can email the maintainer(s).

Coding Style

The source code is automatically formatted to follow go fmt by the [IDE] (https://code.google.com/p/liteide/). And where pragmatic, the source code follows this general [coding style] (http://slamet.neocities.org/coding-style.html).