add: bash export (#7)

* add: bash export
* change: up stage

Author: akirakoyasu

README.md

@@ -12,18 +12,28 @@ pip install aws-paramstore-py
 
 ## Usage
 
-in console
+in shell
 ```bash
 # AWS credentials from env vars
 aws-pspy /path/to/params
 # returns {"key1": "value1", "key2": "value2"}
+
+eval "$(aws-pspy /path/to/params --bash-export)"
+# set env vars:
+# - key1="value1"
+# - key2="value2"
 ```
 
 in Python
 ```python
 import aws_paramstore_py as paramstore
 
-# AWS credentials from env vars
+# use default boto3 ssm client
 params = paramstore.get('/path/to/params')
 # dict(key1: "value1", key2: "value2")
+
+# use your own boto3 ssm client
+import boto3
+ssm = boto3.client('ssm')
+params = paramstore.get('/path/to/params', ssm_client=ssm)
 ```

aws_paramstore_py/__init__.py

@@ -1,18 +1,28 @@
 import argparse
 import json
+import shlex
 
 from .main import get
 
-__version__ = '0.0.4'
+__version__ = '0.0.5'
 
 
 def cli():
+    def print_bash_export(params):
+        for key, value in params.items():
+            var_name = key.replace('/', '_').replace('-', '_').replace('.', '_')
+            var_val = shlex.quote(value)
+            print('export {0}={1}'.format(var_name, var_val))
+
     parser = argparse.ArgumentParser(description='Query params from AWS System Manager Parameter Store')
-    parser.add_argument('paths', metavar='path', nargs='*', help='The hierarchy for the parameter')
+    parser.add_argument('paths', metavar='path', nargs='*', help='The hierarchy for the parameters')
     parser.add_argument('--decryption', action='store_true', help='Decrypt secure values or not')
+    parser.add_argument('--bash-export', action='store_true', help='Print bash export script')
     parser.add_argument('--version', action='version', version=__version__)
     args = parser.parse_args()
-    paths = args.paths
-    decryption = args.decryption
-    params = get(*paths, decryption=decryption)
-    print(json.dumps(params))
+
+    params = get(*args.paths, decryption=args.decryption)
+    if args.bash_export:
+        print_bash_export(params)
+    else:
+        print(json.dumps(params))

aws_paramstore_py/main.py

@@ -1,16 +1,17 @@
 import boto3
 
 
-def get(*paths, decryption=False):
-    ssm = boto3.client('ssm')
+def get(*paths, decryption=False, ssm_client=None):
+    if ssm_client is None:
+        ssm_client = boto3.client('ssm')
     path = _join_slashes(paths)
-    response = ssm.get_parameters_by_path(Path=path, Recursive=True, WithDecryption=decryption)
-    params = map(lambda p: _remove_prefix(p, path), response['Parameters'])
+    response = ssm_client.get_parameters_by_path(Path=path, Recursive=True, WithDecryption=decryption)
+    params = (_remove_prefix(p, path) for p in response['Parameters'])
     return _convert_to_dict(params)
 
 
 def _join_slashes(paths):
-    path = '/'.join(filter(lambda e: len(e), map(lambda e: _remove_slashes_on_edge(e), paths)))
+    path = '/'.join(_remove_slashes_on_edge(e) for e in paths)
     if not path:
         return '/'
     else:
@@ -34,7 +35,10 @@ def _is_followed_by_slash(string):
 
 
 def _remove_prefix(param, prefix):
-    param['Name'] = param['Name'][len(prefix):]
+    name = param['Name']
+    if _is_led_by_slash(name):
+        name = param['Name'][len(prefix):]
+    param['Name'] = name
     return param
 
 

setup.py

@@ -32,7 +32,7 @@
     # For a discussion on single-sourcing the version across setup.py and the
     # project code, see
     # https://packaging.python.org/en/latest/single_source_version.html
-    version='0.0.4',  # Required
+    version='0.0.5',  # Required
 
     # This is a one-line description or tagline of what your project does. This
     # corresponds to the "Summary" metadata field:
@@ -72,7 +72,7 @@
         #   3 - Alpha
         #   4 - Beta
         #   5 - Production/Stable
-        'Development Status :: 3 - Alpha',
+        'Development Status :: 4 - Beta',
 
         # Indicate who your project is intended for
         'Intended Audience :: Developers',

spec/test_main.py

@@ -27,10 +27,20 @@ def test_get_root(self, mock):
 
     def test_get_slash(self, mock):
         method = mock.client('ssm').get_parameters_by_path
+        method.return_value = {'Parameters': [
+            {'Name': '/path/to/params/key1', 'Value': "value1"},
+            {'Name': '/path/to/params/key2', 'Value': "value2"},
+            {'Name': 'root-key3', 'Value': "value3"}
+        ]}
 
-        paramstore.get('/')
+        params = paramstore.get('/')
 
         method.assert_called_with(Path='/', Recursive=True, WithDecryption=False)
+        self.assertDictEqual({
+            "path/to/params/key1": "value1",
+            "path/to/params/key2": "value2",
+            "root-key3": "value3"
+        }, params)
 
     def test_get_leading_slash(self, mock):
         method = mock.client('ssm').get_parameters_by_path