Skip to main content

Utility function to fetch docker secrets/envvars.

Project description

version license pyversions pipeline status coverage

get-docker-secret

Utility function to fetch docker secrets/envvars.

For config values (flask projects) i like to fetch docker secrets and fall back to environment variables for development. This module provides a function to make this a one-liner: use docker secret -> fall back to envvar -> fall back to default value.

The function also provides the possibility to automatically cast the value or specify a custom directory for secrets.

Following assumptions are being made (params):

  • autocast_name=True: secrets are lower-case, envvars upper-case. automatic conversion of name can be switched off via autocast_name=False
  • cast_to=str: fill in desired datatype. special case bool: 'True'/'true' will be True. 'False'/'false' will be False
  • getenv=True: you want to fall back to envvar. can be switched of via getenv=False
  • default=None
  • safe=True: returns None if name not found or cast fails. If you want exceptions: safe=False
  • secrets_dir=/var/run/secrets

Usage

from get_docker_secret import get_docker_secret

value = get_docker_secret('secret_key', default='very_secret')

Testing

python setup.py test

not tested under windows

Changelog

1.0.2 - 2021-03-19

  • Fixed: Only strip trailing newlines from secrets file

1.0.1 - 2019-12-07

  • Fixed: Strip values read from file.

1.0.0 - 2018-01-30

  • Initial publish

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

get-docker-secret-1.0.2.tar.gz (3.5 kB view hashes)

Uploaded source

Built Distributions

get_docker_secret-1.0.2-py3.9.egg (3.9 kB view hashes)

Uploaded 1 0 2

get_docker_secret-1.0.2-py3.8.egg (3.9 kB view hashes)

Uploaded 1 0 2

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page