cloudyr / aws.code Goto Github PK

# AWS Code-Commit/-Deploy/-Pipeline Client Package #

**aws.code** is a simple client package for the Amazon Web Services (AWS) CodeCommit, CodeDeploy, and CodePipeline REST APIs, which can be used to host and deploy applications.

To use the package, you will need an AWS account and enter your credentials into R. Your keypair can be generated on the [IAM Management Console](https://console.aws.amazon.com/iam/home?#security_credential) under the heading *Access Keys*. Note that you only have access to your secret key once. After it is generated, you need to save it in a secure location. New keypairs can be generated at any time if yours has been lost, stolen, or forgotten. 

By default, all **cloudyr** packages look for the access key ID and secret access key in environment variables. You can also use this to specify a default region. For example:

```R
Sys.setenv("AWS_ACCESS_KEY_ID" = "mykey",
           "AWS_SECRET_ACCESS_KEY" = "mysecretkey",
           "AWS_DEFAULT_REGION" = "us-east-1")
```

These can alternatively be set on the command line or via an `Renviron.site` or `.Renviron` file ([see here for instructions](http://cran.r-project.org/web/packages/httr/vignettes/api-packages.html)).

## Code Examples ##

Coming soon....

## Installation ##

[![CRAN](http://www.r-pkg.org/badges/version/aws.code)](http://cran.r-project.org/package=aws.code)
[![Travis Build Status](https://travis-ci.org/cloudyr/aws.code.png?branch=master)](https://travis-ci.org/cloudyr/aws.code) [![codecov.io](http://codecov.io/github/cloudyr/aws.code/coverage.svg?branch=master)](http://codecov.io/github/cloudyr/aws.code?branch=master)

This package is not yet on CRAN. To install the latest development version you can install from the cloudyr drat repository:

```R
# latest stable version
install.packages("aws.code", repos = c(getOption("repos"), "http://cloudyr.github.io/drat"))
```

Or, to pull a potentially unstable version directly from GitHub:

```R
if(!require("remotes")){
if(!require("remotes")){
    install.packages("remotes")
}
remotes::install_github("cloudyr/aws.code")
```


---
[![cloudyr project logo](http://i.imgur.com/JHS98Y7.png)](https://github.com/cloudyr)