Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

A pathy wrapper around aws parameter store

Project description

waddle

the penguins api and tooling around aws's parameter store codebuild

ParamBunch

Lets you access secrets stored in a file or from parameter store!

From a file

Create a file called test.yml that will hold your config.
It can include both secrets and non-secrets

meta:
  kms_key: dev
  region: us-west-2
  profile: mycompany
aws.username: aws-user

Now add a secret to that file using the waddle cli

waddle -f /path/to/test.yml aws.password

waddle will prompt you to enter in the secret. As long as you have a kms key called dev, waddle will add a kms-data-key-encrypted secret into test.yml.

Now you can access configuration values in the test.yml configuration file using the following syntax:

from waddle import ParamBunch
conf = ParamBunch(filename='/path/to/test.yml')
AWS_USERNAME = conf.aws.username
AWS_PASSWORD = conf.get('aws.password', 'some default value')

But I want to use parameter store </whine>

You can also load configs straight from AWS parameter store by providing a prefix.

from waddle import ParamBunch
conf = ParamBunch(prefix='/path/to/parameters')
# Access /path/to/paramaters/aws/username
AWS_USERNAME = conf.aws.username

want to waddle your secrets up to SSM from a file?

In certain cases, you may want to keep files locally, but then push them to aws as part of CI/CD. For example, if you want to keep a centralized repository of your secrets that is shared among developers, you can encrypt secrets in your config files using waddle. For application deployment, you can push those files up to ssm using waddle deploy and/or delete them from ssm using waddle undeploy.

waddle deploy -f /path/to/params.yml
  • or -
waddle undeploy -f /path/to/params.yml

Bunch

A class that offers pathy semantics to access values in a dictionary.

Bunch -- general usage

e.g.,

from waddle import Bunch
values = {
    'a': {
        'b': {
            'c': True,
            'd': False,
        },        
    },
}
a = Bunch(values)
assert a.b.c == True
assert a.b.d == False
a.cat.name = 'mycat'
assert a['cat.name'] == 'mycat'
assert 'cat.age' in a == False
assert a.get('cat.age', 22) == 22
assert a.setdefault('cat.age', 45) == 45

Bunch -- env

You can use the built-in env function to use the dictionary as a set of default values that can be overridden by environment variables.

e.g.,

import os
from waddle import Bunch
os.environ['FTP_PASSWORD'] = 'password'
config = {
    'ftp': {
        'host': '127.0.0.1',
        'user': 'user',
    }
}
config = Bunch(config)
env = config.env()
assert env('FTP_PASSWORD') == 'password'
assert env('FTP_HOST') == '127.0.0.1'

Project details


Download files

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

Files for waddle, version 0.8
Filename, size File type Python version Upload date Hashes
Filename, size waddle-0.8-py3-none-any.whl (10.8 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size waddle-0.8.tar.gz (10.8 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page