vmware-labs / vmware-customer-connect-sdk

Golang based SDK to interact with customerconnect.vmware.com. It is used in a CLI that enables product downloads from customerconnect: https://github.com/vmware-labs/vmware-customer-connect-cli
Apache License 2.0
3 stars 0 forks source link

vmware-customer-connect-sdk

This SDK builds a layer of abstraction above customerconnect.vmware.com to hide the complexity for the client. This allows for downloads to be requested using the minimum of information.

WARNING: This SDK is unofficial and experimental, with no guarantee of API stability.

Overview

This code is not meant to be compiled directly, but rather be consumed by another compiled program.

Prerequisites

See go.mod for details of the version of Golang used.

Install modules with go mod download from the root of the repo.

You must export environmental variables with your credentials to VMware Customer Connect. A generic account with no specific entitlement is required. Make sure that password are enclosed in single quotes to prevent issues with special charactors in passwords.

export VMWCC_USER='<user@name>'
export VMWCC_PASS='<password>'

Testing

Run test with go test ./....

Updating dependencies

Run GOPROXY=direct go get -u ./... to pull in the latest dependencies.

Contributing

Please see our Code of Conduct and Contributors guide.

The vmware-customer-connect-sdk project team welcomes contributions from the community. Before you start working with vmware-customer-connect-sdk, please read and sign our Contributor License Agreement CLA. If you wish to contribute code and you have not signed our contributor license agreement (CLA), our bot will prompt you to do so when you open a Pull Request. For any questions about the CLA process, please refer to our FAQ.

License

Apache License

Credit [@hoegaarden] (https://github.com/hoegaarden) for some of the original code.