{"id":17343027,"url":"https://github.com/aacanakin/env","last_synced_at":"2025-04-14T19:53:28.694Z","repository":{"id":57538821,"uuid":"287639739","full_name":"aacanakin/env","owner":"aacanakin","description":"Environment variable parser, mapper to go structs","archived":false,"fork":false,"pushed_at":"2020-08-16T00:30:24.000Z","size":28,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-28T08:12:05.532Z","etag":null,"topics":["env","golang","mapper","parser"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aacanakin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-08-14T23:02:53.000Z","updated_at":"2020-09-13T07:23:46.000Z","dependencies_parsed_at":"2022-09-19T07:30:53.987Z","dependency_job_id":null,"html_url":"https://github.com/aacanakin/env","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aacanakin%2Fenv","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aacanakin%2Fenv/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aacanakin%2Fenv/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aacanakin%2Fenv/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aacanakin","download_url":"https://codeload.github.com/aacanakin/env/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248951977,"owners_count":21188420,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["env","golang","mapper","parser"],"created_at":"2024-10-15T16:08:07.560Z","updated_at":"2025-04-14T19:53:28.675Z","avatar_url":"https://github.com/aacanakin.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# env: Parse environment variables, map to structs\n\n![Go](https://github.com/aacanakin/env/workflows/Go/badge.svg) [![Go Report Card](https://goreportcard.com/badge/github.com/aacanakin/env)](https://goreportcard.com/report/github.com/aacanakin/env) [![Coverage Status](https://coveralls.io/repos/github/aacanakin/env/badge.svg?branch=master)](https://coveralls.io/github/aacanakin/env?branch=master)\n\nenv is a mapper from environment variables to structs\n\n## Features\n\n- Ability to map environment variables to structs\n- Ability to customize environment variables with struct tags\n- Ability to parse nested/sub structs\n- Ability to parse embedded nested/sub structs\n- Ability to parse and map types (`bool`, `string`, `int`, `int8`, `int16`, `int32`, `int64`, `uint`, `uint8`, `uint16`, `uint32`, `uint64`, `float32`, `float64`, `complex64`, `complex128`, `struct`)\n\n## Getting started\n\n### Install\n\n```sh\n// Requires go1.15+\n\ngo get github.com/aacanakin/env\n```\n\n### Usage\n\n```go\n// main.go\npackage main\n\nimport \"fmt\"\nimport \"github.com/aacanakin/env\"\n\ntype Config struct {\n  Host string\n  Port int\n  Debug bool\n}\n\nfunc main() {\n\n  var c Config\n\n  err := env.Parse(\u0026c)\n  if err != nil {\n    panic(err)\n  }\n\n  fmt.Println(\"Host: \", c.Host)\n  fmt.Println(\"Port: \", c.Port)\n  fmt.Println(\"Debug: \", c.Debug)\n}\n```\n\nRun\n\n```sh\n$ HOST=localhost PORT=8081 debug=true go run main.go\n\n// Output\nHost:  localhost\nPort:  8081\nDebug:  true\n```\n\n### Custom environment var mapping\n\n```go\n// main.go\npackage main\n\nimport \"fmt\"\nimport \"github.com/aacanakin/env\"\n\nfunc main() {\n  type Config struct {\n    Host string `env:\"SERVICE_HOST\"`\n    Port int    `env:\"SERVICE_PORT\"`\n    Debug bool  `env:\"SERVICE_DEBUG\"`\n  }\n\n  var c Config\n\n  err := env.Parse(\u0026c)\n  if err != nil {\n    panic(err)\n  }\n\n  fmt.Println(\"Host: \", c.Host)\n  fmt.Println(\"Port: \", c.Port)\n  fmt.Println(\"Debug: \", c.Debug)\n}\n```\n\nRun\n\n```sh\nSERVICE_HOST=localhost SERVICE_PORT=8081 SERVICE_DEBUG=true go run main.go\n\n// Output\nHost:  localhost\nPort:  8081\nDebug:  true\n```\n\n### Nested/Sub structs\n\n```go\n// main.go\npackage main\n\nimport \"fmt\"\nimport \"github.com/aacanakin/env\"\n\ntype db struct {\n  Host string `env:\"DB_HOST\"`\n  Port int `env:\"DB_PORT\"`\n}\n\ntype service struct {\n  Debug bool `env:\"SERVICE_DEBUG\"`\n}\n\ntype Config struct {\n  DB db\n  Service service\n}\n\nfunc main() {\n  var c Config\n\n  err := env.Parse(\u0026c)\n  if err != nil {\n    panic(err)\n  }\n\n  fmt.Println(\"DB Host: \", c.DB.Host)\n  fmt.Println(\"DB Port: \", c.DB.Port)\n  fmt.Println(\"Service Debug: \", c.Service.Debug)\n}\n\n```\n\nRun\n\n```sh\nDB_HOST=localhost DB_PORT=3306 SERVICE_DEBUG=true go run main.go\n\n// Output\nDB Host:  localhost\nDB Port:  3306\nService Debug:  true\n```\n\n### Using with .env\n\nInstall\n\n```sh\ngo get github.com/joho/godotenv\n```\n\nCreate a .env file\n\n```sh\n# .env\nHOST=localhost\nPORT=8081\n```\n\n```go\n// main.go\npackage main\n\nimport (\n  \"github.com/joho/godotenv\"\n  \"github.com/aacanakin/env\"\n  \"log\"\n)\n\ntype Config struct {\n  Host string\n  Port uint16\n}\n\nfunc main() {\n  err := godotenv.Load()\n  if err != nil {\n    log.Fatal(\"Error loading .env file\")\n  }\n\n  var c Config\n\n  err = env.Parse(\u0026c)\n\n  log.Println(\"Host: \", c.Host)\n  log.Println(\"Port: \", c.Port)\n}\n```\n\n### Readonly config\n\nSince it's a good practice to keep environment variables immutable, it will be also a good practice to keep the parsed struct immutable too. However, Go's reflect package doesn't allow setting unexported fields. So,\nto keep the struct immutable;\n\n- Create a config package\n\n```go\npackage config\n\nimport \"github.com/aacanakin/env\"\n\ntype conf struct {\n\tHost string\n\tPort uint16\n}\n\ntype Config struct {\n\tconf conf\n}\n\nfunc (c Config) Host() string {\n\treturn c.conf.Host\n}\n\nfunc (c Config) Port() uint16 {\n\treturn c.conf.Port\n}\n\nfunc New() (*Config, error) {\n\tvar c conf\n\terr := env.Parse(\u0026c)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn \u0026Config{c}, nil\n}\n```\n\n- Use it in your main.go\n\n```go\npackage main\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/aacanakin/env_test/config\"\n)\n\nfunc main() {\n  c, err := config.New()\n  if err != nil {\n    panic(err)\n  }\n\n  // HERE, c.conf is not accessible\n  fmt.Println(\"Host:\", c.Host())\n  fmt.Println(\"Port:\", c.Port())\n}\n\n```\n\nNOTE: This looks like it's not very idiomatic go. Feedbacks here are welcome.\n\n## Roadmap\n\n- [ ] `omitempty` tag constraint\n- [ ] `file` tag constraint\n- [ ] Ability to customize tag key (default is env)\n- [ ] Provide an instance based parser\n- [ ] Provide a read only config example with custom conf package\n- [ ] Release v0.1\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faacanakin%2Fenv","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faacanakin%2Fenv","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faacanakin%2Fenv/lists"}