Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/grottopress/envy
Load environment variables from YAML
https://github.com/grottopress/envy
configuration crystal dotenv environment yaml
Last synced: about 1 month ago
JSON representation
Load environment variables from YAML
- Host: GitHub
- URL: https://github.com/grottopress/envy
- Owner: GrottoPress
- License: mit
- Created: 2020-01-18T16:23:22.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-06-21T21:08:00.000Z (3 months ago)
- Last Synced: 2024-06-22T18:11:43.503Z (3 months ago)
- Topics: configuration, crystal, dotenv, environment, yaml
- Language: Crystal
- Homepage:
- Size: 32.2 KB
- Stars: 7
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-crystal - Envy - Load environment variables from YAML (Configuration)
README
# Envy
**Envy** loads and sets environment variables from YAML. It supports all YAML data types, including arrays and hashes.
*Envy* uses the YAML key mapping of a value as the environment variable name. For example, the following YAML configuration...
```yaml
---
app:
database:
host: localhost
port: 4321
server:
hosts:
- localhost
- grottopress.localhost
port: 8080
webhooks:
- url: "https://example.com"
token: "a1b2c2"
- url: "https://myapp.net"
token: "d4e5f6"
```
...sets environment variables as follows:
```crystal
ENV["APP_DATABASE_HOST"] = "localhost"
ENV["APP_DATABASE_PORT"] = "4321"
ENV["APP_SERVER_HOSTS_0"] = "localhost"
ENV["APP_SERVER_HOSTS_1"] = "grottopress.localhost"
ENV["APP_SERVER_PORT"] = "8080"
ENV["APP_WEBHOOKS_0_URL"] = "https://example.com"
ENV["APP_WEBHOOKS_0_TOKEN"] = "a1b2c2"
ENV["APP_WEBHOOKS_1_URL"] = "https://myapp.net"
ENV["APP_WEBHOOKS_1_TOKEN"] = "d4e5f6"
```
It sets file permission (`0600` by default) for all config files.
*Envy* supports loading a file from a supplied list of files in decreasing order of priority; the first readable file is loaded.
## Installation
1. Add the dependency to your `shard.yml`:
```yaml
dependencies:
envy:
github: GrottoPress/envy
```
2. Run `shards install`
## Usage
- Load the first readable file from a supplied list of files. Optionally set files permissions. This does *not* overwrite existing environment variables:
```crystal
require "envy"
Envy.from_file ".env.yml", ".env.dev.yml", perm: 0o400
```
- Load the first readable file from a supplied list of files. Optionally set files permissions. This *overwrites* existing environment variables:
```crystal
require "envy"
Envy.from_file! ".env.yml", ".env.dev.yml", perm: 0o400
```
## Contributing
1. [Fork it](https://github.com/GrottoPress/envy/fork)
1. Switch to the `master` branch: `git checkout master`
1. Create your feature branch: `git checkout -b my-new-feature`
1. Make your changes, updating changelog and documentation as appropriate.
1. Commit your changes: `git commit`
1. Push to the branch: `git push origin my-new-feature`
1. Submit a new *Pull Request* against the `GrottoPress:master` branch.