Berglas Library for Python

This library automatically parses berglas references when imported.

Only Python 3.6+ is supported currently.

You can find the latest, most up to date, documentation on Github.

Quick Start

Install library:

pip install berglas

Import the module:

import berglas.auto  # noqa

When imported, the berglas module will:

1. Detect the runtime environment and call the appropriate API to get the list of environment variables that were set on the resource at deploy time

1. Download and decrypt any secrets that match the Berglas environment variable reference syntax

1. Replace the value for the environment variable with the decrypted secret

You can also opt out of auto-parsing and call the library yourself instead:

import os

from berglas import resolver

if __name__ == '__main__':
    client = resolver.Client()
    client.replace("MY_SECRET")
    print(os.environ["MY_SECRET"])

    // alternatively, use resolve method to simply get the value without updating environment:
    my_secret = client.resolve(os.environ["MY_SECRET"])
    print(my_secret)

Release Notes

v0.1

• First version

Development

Getting Started

Assuming that you have Python, pyenv and pyenv-virtualenv installed, set up your environment and install the required dependencies like this instead of the pip install berglas defined above:

$ git clone https://github.com/maroux/berglas-python.git
$ cd python
$ pyenv virtualenv 3.9.14 berglas-3.9
...
$ pyenv shell berglas-3.9
$ pip install setuptools==58
$ pip install -r requirements/dev-3.9.txt

Updating Requirements Files

Update the install_requires variable in setup.py and then from the pyenv virtualenv shell run: .. code:: sh

$ python -m pip install pip==18.0 pip-tools==3.2.0 --upgrade $ make pip_compile

Running Tests

You can run tests in using make test. By default, it will run all of the unit and functional tests, but you can also specify your own py.test options.

$ py.test

Getting Help

We use GitHub issues for tracking bugs and feature requests.

• If it turns out that you may have found a bug, please open an issue