Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gowizzard/dotenv
An very lightweight library for dotenv files or for formatting already imported variables.
https://github.com/gowizzard/dotenv
dotenv environment environment-variables formatting go golang golang-library import
Last synced: 14 days ago
JSON representation
An very lightweight library for dotenv files or for formatting already imported variables.
- Host: GitHub
- URL: https://github.com/gowizzard/dotenv
- Owner: gowizzard
- License: mit
- Created: 2022-12-08T08:19:54.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-13T10:31:15.000Z (over 1 year ago)
- Last Synced: 2024-06-21T09:51:52.452Z (5 months ago)
- Topics: dotenv, environment, environment-variables, formatting, go, golang, golang-library, import
- Language: Go
- Homepage:
- Size: 72.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# dotenv
[](https://golang.org/) [](https://github.com/gowizzard/dotenv/actions/workflows/go.yml) [](https://github.com/gowizzard/dotenv/actions/workflows/codeql.yml) [](https://github.com/gowizzard/dotenv/actions/workflows/compver.yml) [](https://pkg.go.dev/github.com/gowizzard/dotenv/v2) [](https://goreportcard.com/report/github.com/gowizzard/dotenv/v2) [](https://github.com/gowizzard/dotenv/issues) [](https://github.com/gowizzard/dotenv/network) [](https://github.com/gowizzard/dotenv/stargazers) [](https://github.com/gowizzard/dotenv/blob/master/LICENSE)
With this lightweight library you can read a local file with environment variables into your project. Additionally, you can use functions to read the data and the variable will be returned directly in the desired type.
## Installation
First you have to install the package. You can do this as follows:
```shell
go get github.com/gowizzard/dotenv/v2
```
## How to use
## Import variables
If you want to read your local `.env` file, so you can use these variables in your project, you can use this function for that.
With this function the data will be loaded from the file and set as local variables. After that you can read them with standard functions, or you can use the following functions.
[Here](https://regex101.com/r/SEDjKj/10) you can find the regex expression which is used to read the environment variables.
```go
err := dotenv.Import(".env")
if err != nil {
panic(err)
}
```
## Read variables
If you don't want to work with the standard golang function `func Getenv(key string) string` from the `package os` or `func Getenv(key string) (value string, found bool)` from `package syscall`, because you want to output the variables directly in a certain type, then you can use the following different functions.
The functions check directly if the desired variable is available and returns the value. If the value is not available, then the default value of the type is returned.
You can also use these functions without the import function if the variables are already available locally.
### Boolean
With this function you can read an environment variable and return it directly as `type bool`.
```go
result := dotenv.Boolean("KEY")
println(result)
```
### Float
With this function you can read an environment variable and return it directly as `type float64`. In this function you must not only specify the desired key, but also the bit size of the float type. The bit size can be between `0 to 64`.
```go
result := dotenv.Float("KEY", 64)
println(result)
```
### Integer
With this function you can read an environment variable and return it directly as `type int64`. In this function, the base and the bit size must be specified in addition to the key. The base must contain one of the following values `0, 2 to 36` and the bit size can be between `0 to 64`.
```go
result := dotenv.Integer("KEY", 10, 64)
println(result)
```
### String
With this function you can read an environment variable and return it directly as `type string`.
```go
result := dotenv.String("KEY")
println(result)
```
## Special thanks
Thanks to [JetBrains](https://github.com/JetBrains) for supporting me with this and other [open source projects](https://www.jetbrains.com/community/opensource/#support).