README.md
<h1 align="center">
<br>
<img src="https://cdn.rawgit.com/pedrolopesme/s3tools/56bed919/docs/logo.svg" width="64px" /> <br />
S3 Tools
<br>
</h1>
<h4 align="center">S3 common utilities</h4>
<p align="center">
<a href="https://travis-ci.org/pedrolopesme/s3tools"> <img src="https://api.travis-ci.org/pedrolopesme/s3tools.svg?branch=master" /></a>
<a href="https://goreportcard.com/report/github.com/pedrolopesme/s3tools"> <img src="https://goreportcard.com/badge/github.com/pedrolopesme/s3tools" /></a>
<a href="https://codeclimate.com/github/pedrolopesme/s3tools/maintainability"> <img src="https://api.codeclimate.com/v1/badges/802610de39eefd49d4e4/maintainability" /></a>
<a href='https://coveralls.io/github/pedrolopesme/s3tools?branch=master'><img src='https://coveralls.io/repos/github/pedrolopesme/s3tools/badge.svg?branch=master' alt='Coverage Status' /></a>
</p>
<br>
### Usage
S3Tools is design to provider a set of utilities related to S3 files manipulation, such as:
| <center> [<img src="https://cdn.rawgit.com/pedrolopesme/s3tools/70a4efb6/docs/file.svg" width="32px" /> <br/> Cat](docs/CAT.md) </center> | <center> [<img src="https://cdn.rawgit.com/pedrolopesme/s3tools/56bed919/docs/magnifying-glass.svg" /> <br/> Grep](docs/GREP.md) </center> |
|---|---|
### Makefile
This project provides a Makefile with all common operations need to develop, test and build call-it.
* build: generates binaries
* test: runs all tests
* clean: removes binaries
* fmt: runs gofmt for all go files
* coverage: runs tests coverage build on Coveralls. It expects you to have declared COVERALLS_S3TOOLS_KEY env var.
### Running tests
Tests were write using [Testify](https://github.com/stretchr/testify). In order to run them, just type:
```shell
$ make test
```
### Credits
These are the main external packages that make up Call It:
| packages | description |
|---|---|
| **[Aurora](https://github.com/logrusorgru/aurora)** | **Ultimate ANSI colors for Golang. The package supports Printf/Sprintf etc.** |
| **[AWS SDK Go](https://github.com/aws/aws-sdk-go)** | **AWS SDK for the Go programming language** |
| **[Cobra](https://github.com/spf13/cobra)** | **A Commander for modern Go CLI interactions** |
| **[Fsnotify](https://github.com/fsnotify/fsnotify)** | **Cross-platform file system notifications for Go.** |
| **[HCL](https://github.com/hashicorp/hcl)** | **HCL is the HashiCorp configuration language.** |
| **[go-difflib](https://github.com/pmezard/go-difflib)** | **Partial port of Python difflib package to Go.** |
| **[go-homedir](https://github.com/mitchellh/go-homedir)** | **Go library for detecting and expanding the user's home directory without cgo.** |
| **[go-jmespath](https://github.com/jmespath/go-jmespath)** | **Golang implementation of JMESPath.** |
| **[go-toml](https://github.com/pelletier/go-toml)** | **Go library for the TOML language.** |
| **[mapstructure](https://github.com/jmespath/mapstructure)** | **Go library for decoding generic map values into native Go structures.** |
| **[Properties](https://github.com/magiconair/properties)** | **Java properties scanner for Go** |
| **[Testify](https://github.com/stretchr/testify)** | **A toolkit with common assertions and mocks that plays nicely with the standard library** |
S3Tools icons made by [Freepik](http://www.freepik.com/).
### License
[MIT](LICENSE.md)