| single |
# pyyaml_env_tag
A custom YAML tag for referencing environment variables in YAML files.
## Installation
Install `PyYAML` and the `pyyaml_env_tag` package with pip:
`bash
pip install pyyaml pyyaml_env_tag
`
### Enabling the tag
To enable the tag, import and add the `construct_env_tag` constructor to
your YAML
loader of choice.
```python
import yaml
from yaml_env_tag import construct_env_tag
yaml.Loader.add_constructor('!ENV', construct_env_tag)
```
Then you may use the loader as per usual. For example:
```python
yaml.load(data, Loader=yaml.Loader)
```
## Using the tag
Include the tag `!ENV` followed by the name of an environment variable in a
YAML
file and the value of the environment variable will be used in its place.
```yaml
key: !ENV SOME_VARIABLE
```
If `SOME_VARIABLE` is set to `A string!`, then the above YAML would result
in the
following Python object:
```python
{'key': 'A string!'}
```
The content of the variable is parsed using YAML's implicit scalar types,
such as
string, bool, integer, float, datestamp and null. More complex types are
not
recognized and simply passed through as a string. For example, if
`SOME_VARIABLE`
was set to the string `true`, then the above YAML would result in the
following:
```python
{'key': True}
```
If the variable specified is not set, then a `null` value is assigned as a
default.
You may define your own default as the last item in a sequence.
```yaml
key: !ENV [SOME_VARIABLE, default]
```
In the above example, if `SOME_VARIABLE` is not defined, the string
`default` would
be used instead, as follows:
```python
{'key': 'default'}
```
You may list multiple variables as fallbacks. The first variable which is
set is
used. In any sequance with more than one item, the last item must always be
a
default value and will not be resolved as an environment variable.
```yaml
key: !ENV [SOME_VARIABLE, FALLBACK, default]
```
As with variable contents, the default is resolved to a Python object of
the
implied type (string, bool, integer, float, datestamp and null).
When `SOME_VARIABLE` is not set, all four of the following items will
resolve to
the same value (`None`):
```yaml
- !ENV SOME_VARIABLE
- !ENV [SOME_VARIABLE]
- !ENV [SOME_VARIABLE, ~]
|