acampbel / dotenv-for-MATLAB

Load environment variables from a .env file.

dotenv for MATLAB

A MATLAB implementation of the dotenv pattern.

Storing configuration in the environment separate from code is based on The Twelve-Factor App methodology. dotenv for MATLAB® lets you store configuration data (passwords, API keys, server names, etc.) outside of your code. This lets you share your code without sharing your configuration data.

Installation

Put dotenv.m somewhere on your search path.

Usage Example

dotenv() will try and load a file named .env from the current working folder. Alternatively, you can specify the path with dotenv('path/to/file.env').

.env

API_KEY=ybvxtzwaxa:r42DtRhuUT7TywYpzBABOFZ0IIomwuIEXnfFVq2VSXjRC

file.m

d = dotenv();
opts = weboptions('HeaderField', ["accept", "any"; "authorization", d.env.API_KEY])
url = "https://myurl.com"
response = webread(url, opts);

Common places you may need to do this are weboptions(), the Database Toolbox, or ftp().

Rules

The parsing engine currently supports the following rules:

• empty lines are skipped
• lines beginning with # are treated as comments
• empty values become empty strings (DB_HOST= becomes DBHOST: '')
• whitespace is removed from both ends of unquoted values (DB_HOST=some server becomes DB_HOST:'some server')
• quoted values are escaped (DB_PASS=" some password " becomes DB_PASS:' some password ')

FAQ

Should I commit my .env file?

No. You should put *.env in your .gitignore file.

Development Setup

Clone the repository. You can run runtests('tests') from the project root to run the unit test suite.

Bugs?

I would love to hear if this breaks on any weird strings or doesn't work the way you expected.