Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/attumm/settingo
Golang settings should be simple, boring and forget-able. With settingo it will be just that.
https://github.com/attumm/settingo
golang golang-library golang-package setting settings settings-management
Last synced: 13 days ago
JSON representation
Golang settings should be simple, boring and forget-able. With settingo it will be just that.
- Host: GitHub
- URL: https://github.com/attumm/settingo
- Owner: Attumm
- License: mit
- Created: 2021-05-27T12:43:13.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-25T20:55:34.000Z (about 1 month ago)
- Last Synced: 2024-11-25T21:36:31.935Z (about 1 month ago)
- Topics: golang, golang-library, golang-package, setting, settings, settings-management
- Language: Go
- Homepage:
- Size: 30.3 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Settingo
## _Settings should be simple, and with settingo it is._
Settings parses command line and environment variables on one line.
And makes it available throughout the code base. Making using settings in your project as boring and unimportant as it should be.
Settings vars is as simple as:
```go
settingo.Set("FOO", "default value", "help text")
```
Getting vars out has the same level of complexity as setting the value.
```go
settingo.Get("FOO")
```
## Features
- Simplicity: Set up settings within a single line of code.
- Flexibility: Utilize command-line flags, environment variables, or defaults.
- Typesafety: Seamlessly work with strings, integers, booleans, and maps.
- Convenience: Global access with a singleton pattern.
- User-friendly: Automatic --help flag generation for your applications.
- Versatility: Works flawlessly in Linux, Docker, Kubernetes, and other environments.
## Example
example of how to use. More can be found in the [example_project](https://github.com/Attumm/settingo_example_project/blob/main/main.go)
```go
package main
import (
"fmt"
"github.com/Attumm/settingo/settingo"
)
func main() {
settingo.Set("FOO", "default value", "handy help text")
settingo.Parse()
fmt.Println("foo =", settingo.Get("FOO"))
}
```
The above go will produce binary that can be used as follows.
Get handy help text set in the above example on the same line.
This can get very handy when the project grows and is used in different environments
```sh
$ ./example --help
Usage of ./example:
-FOO string
handy help text (default "default value")
```
When no value is given, default value is used
```sh
$ ./example
foo = default value
```
Running the binary with command line input
```sh
$ ./example -FOO bar
foo = bar
```
Running the binary with environment variable
```sh
$ FOO=ok;./example
foo = ok
```
## Order of preference
variables are set with preference
variables on the command line will have highest preference.
This because while testing you might want to override environment
The priority order is as follows
1. Command line input
2. Environment variables
3. Default values
## Types
Settingo supports different types.
```go
// string
settingo.Set("FOO", "default", "help text")
settingo.Get("FOO")
// integer
settingo.SetInt("FOO", 42, "help text")
settingo.GetInt("FOO")
// boolean
settingo.SetBool("FOO", true, "help text")
settingo.GetBool("FOO")
// map
defaultMap := make(map[string][]string)
defaultMap["foo"] = []string{"bar"}
settingo.SetMap("FOO", defaultMap, "help text")
settingo.GetMap("FOO")
```
## installation
```bash
go get "github.com/Attumm/settingo/settingo"
```
## Example project
Handy [example_project](https://github.com/Attumm/settingo_example_project) as starting point.
## License
MIT