Envy

Load environment variables from YAML

Programming language: Crystal

License: MIT License

Tags: Configuration    

Latest version: v0.3.0

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...

---
app:
  database:
    host: localhost
    port: 4321
  server:
    hosts:
      - localhost
      - grottopress.localhost
    port: 8080

...sets environment variables as follows:

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"

Envy loads environment variables only once per application life-cycle. This avoids the overhead of reading and parsing YAML files on every single request.

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:

   dependencies:
     envy:
       github: GrottoPress/envy

1. 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:

  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:

  require "envy"
  
  Envy.from_file! ".env.yml", ".env.dev.yml", perm: 0o400
  

Contributing

1. Fork it
2. Switch to the master branch: git checkout master
3. Create your feature branch: git checkout -b my-new-feature
4. Make your changes, updating changelog and documentation as appropriate.
5. Commit your changes: git commit
6. Push to the branch: git push origin my-new-feature
7. Submit a new Pull Request against the GrottoPress:master branch.