gopkg.in/essentialkaos/ek.v3@v3.5.1/readme.md (about)

     1  # `EK` [![GoDoc](https://godoc.org/pkg.re/essentialkaos/ek.v3?status.svg)](https://godoc.org/pkg.re/essentialkaos/ek.v3) [![Go Report Card](https://goreportcard.com/badge/github.com/essentialkaos/ek)](https://goreportcard.com/report/github.com/essentialkaos/ek) [![codebeat badge](https://codebeat.co/badges/3649d737-e5b9-4465-9765-b9f4ebec60ec)](https://codebeat.co/projects/github-com-essentialkaos-ek)
     2  
     3  Auxiliary packages for Go.
     4  
     5  ### Platform support
     6  
     7  Currently we support Linux and Mac OS X. Some packages have stubs for Windows (_for autocomplete_).
     8  
     9  ### Installation
    10  
    11  ````
    12  go get pkg.re/essentialkaos/ek.v3
    13  ````
    14  
    15  If you want update ek to latest stable release, do:
    16  
    17  ````
    18  go get -u pkg.re/essentialkaos/ek.v3
    19  ````
    20  
    21  ### Packages
    22  
    23  * [`arg`](https://godoc.org/pkg.re/essentialkaos/ek.v3/arg) - Package provides methods for working with command-line arguments
    24  * [`color`](https://godoc.org/pkg.re/essentialkaos/ek.v3/color) - Package color provides methods for working with colors
    25  * [`cron`](https://godoc.org/pkg.re/essentialkaos/ek.v3/cron) - Package provides methods for working with cron expressions
    26  * [`crypto`](https://godoc.org/pkg.re/essentialkaos/ek.v3/crypto) - Package with utils for working with crypto data (passwords, uuids, file hashes)
    27  * [`csv`](https://godoc.org/pkg.re/essentialkaos/ek.v3/csv) - Package with simple (without any checks) csv parser compatible with default Go parser
    28  * [`easing`](https://godoc.org/pkg.re/essentialkaos/ek.v3/easing) - Package with easing functions (Back, Bounce, Circ, Cubic, Elastic, Expo, Linear, Quad, Quint, Sine)
    29  * [`env`](https://godoc.org/pkg.re/essentialkaos/ek.v3/env) - Package provides methods for working with environment variables
    30  * [`errutil`](https://godoc.org/pkg.re/essentialkaos/ek.v3/errutil) - Package provides methods for working with errors
    31  * [`fmtc`](https://godoc.org/pkg.re/essentialkaos/ek.v3/fmtc) - Package provides methods similar to fmt for colored output
    32  * [`fmtutil`](https://godoc.org/pkg.re/essentialkaos/ek.v3/fmtutil) - Package provides methods for output formating
    33  * [`fsutil`](https://godoc.org/pkg.re/essentialkaos/ek.v3/fsutil) - Package provides methods for working with files on posix compatible systems (Linux / Mac OS X)
    34  * [`httputil`](https://godoc.org/pkg.re/essentialkaos/ek.v3/httputil) - Package provides methods for working with http request/responses
    35  * [`jsonutil`](https://godoc.org/pkg.re/essentialkaos/ek.v3/jsonutil) - Package provides methods for working with json data
    36  * [`knf`](https://godoc.org/pkg.re/essentialkaos/ek.v3/knf) - Package provides methods for working with configs in KNF format
    37  * [`kv`](https://godoc.org/pkg.re/essentialkaos/ek.v3/kv) - Package provides simple key-value structs
    38  * [`log`](https://godoc.org/pkg.re/essentialkaos/ek.v3/log) - Package with improved logger
    39  * [`mathutil`](https://godoc.org/pkg.re/essentialkaos/ek.v3/mathutil) - Package with math utils
    40  * [`netutil`](https://godoc.org/pkg.re/essentialkaos/ek.v3/netutil) - Package with network utils
    41  * [`path`](https://godoc.org/pkg.re/essentialkaos/ek.v3/path) - Package for working with paths (fully compatible with base path package)
    42  * [`pid`](https://godoc.org/pkg.re/essentialkaos/ek.v3/pid) - Package for working with pid files
    43  * [`pluralize`](https://godoc.org/pkg.re/essentialkaos/ek.v3/pluralize) - Package pluralize provides methods for pluralization
    44  * [`rand`](https://godoc.org/pkg.re/essentialkaos/ek.v3/rand) - Package for generating random data
    45  * [`req`](https://godoc.org/pkg.re/essentialkaos/ek.v3/req) - Package for working with http request
    46  * [`signal`](https://godoc.org/pkg.re/essentialkaos/ek.v3/signal) - Package for handling signals
    47  * [`sliceutil`](https://godoc.org/pkg.re/essentialkaos/ek.v3/sliceutil) - Package with utils for working with slices
    48  * [`sortutil`](https://godoc.org/pkg.re/essentialkaos/ek.v3/sortutil) - Package with utils for sorting slices
    49  * [`spellcheck`](https://godoc.org/pkg.re/essentialkaos/ek.v3/spellcheck) - Package provides spellcheck based on Damerau–Levenshtein distance algorithm
    50  * [`strutil`](https://godoc.org/pkg.re/essentialkaos/ek.v3/strutil) - Package provides utils for working with strings
    51  * [`system`](https://godoc.org/pkg.re/essentialkaos/ek.v3/system) - Package provides methods for working with system data (metrics/users)
    52  * [`system/process`](https://godoc.org/pkg.re/essentialkaos/ek.v3/system/process) - Package provides methods for getting information about active processes
    53  * [`terminal`](https://godoc.org/pkg.re/essentialkaos/ek.v3/terminal) - Package provides methods for working with user input
    54  * [`timeutil`](https://godoc.org/pkg.re/essentialkaos/ek.v3/timeutil) - Package with time utils
    55  * [`tmp`](https://godoc.org/pkg.re/essentialkaos/ek.v3/tmp) - Package provides methods for working with temporary data
    56  * [`usage`](https://godoc.org/pkg.re/essentialkaos/ek.v3/usage) - Package provides methods for rendering info for command-line tools
    57  * [`version`](https://godoc.org/pkg.re/essentialkaos/ek.v3/version) - Package provides methods for parsing semver version info
    58  
    59  ### Projects with EK
    60  
    61  * [sslcli](https://github.com/essentialkaos/sslcli) - Pretty awesome command-line client for public SSLLabs API
    62  * [redis-cli-monitor](https://github.com/essentialkaos/redis-cli-monitor) - Tiny redis client for renamed MONITOR commands
    63  * [shdoc](https://github.com/essentialkaos/shdoc) - Tool for viewing and exporting docs for shell scripts
    64  * [rbinstall](https://github.com/essentialkaos/rbinstall) - Utility for installing prebuilt ruby to RBEnv
    65  * [mockka](https://github.com/essentialkaos/mockka) - Mockka is a simple utility for mocking HTTP API's
    66  * [terrafarm](https://github.com/essentialkaos/terrafarm) - Utility for working with terraform based rpmbuilder farm
    67  * [mdtoc](https://github.com/essentialkaos/mdtoc) - Utility for generating table of contents for markdown files
    68  
    69  ### Test & Coverage Status
    70  
    71  | Branch | TravisCI | CodeCov |
    72  |--------|----------|---------|
    73  | `master` | [![Build Status](https://travis-ci.org/essentialkaos/ek.svg?branch=master)](https://travis-ci.org/essentialkaos/ek) | [![codecov.io](https://codecov.io/github/essentialkaos/ek/coverage.svg?branch=master)](https://codecov.io/github/essentialkaos/ek?branch=master) |
    74  | `develop` | [![Build Status](https://travis-ci.org/essentialkaos/ek.svg?branch=develop)](https://travis-ci.org/essentialkaos/ek) | [![codecov.io](https://codecov.io/github/essentialkaos/ek/coverage.svg?branch=develop)](https://codecov.io/github/essentialkaos/ek?branch=develop) |
    75  | `tip` |  [![Build Status](https://travis-ci.org/essentialkaos/ek.svg?branch=tip)](https://travis-ci.org/essentialkaos/ek) | - |
    76  
    77  ### License
    78  
    79  [EKOL](https://essentialkaos.com/ekol)