Add configurable options

README.md

@@ -38,11 +38,24 @@ if __name__ == "__main__":
     print("Secret: %s" % secret)
 ```
 
-- Run the sample application. You must provide the dedicated user's access key and secret key, and the region as environment variables.
+- Run the sample application. You must provide the dedicated user's access key and secret key, and the region as environment variables or pass to `configure` function.
+
+### Provide as environment variables
 ```bash
 $ export SECRETKEEPER_AWS_ACCESS_KEY="YOUR_ACCESS_KEY_ID"
 $ export SECRETKEEPER_AWS_SECRET_KEY="YOUR_SECRET_ACCESS_KEY"
 $ export SECRETKEEPER_AWS_REGION="us-east-1"
 $ python sample.py
 Secret: pa$$w@rd!
 ```
+
+### Pass to `configure` function
+```python
+from ridi import secret_keeper
+
+secret_keeper.configure(
+    aws_access_key="YOUR_ACCESS_KEY_ID",
+    aws_secret_key="YOUR_SECRET_ACCESS_KEY",
+    aws_region="us-east-1",
+)
+```

ridi/secret_keeper/__init__.py

@@ -1,38 +1,2 @@
-import os
-
-import boto3
-
-ENVNAME_AWS_ACCESS_KEY = "SECRETKEEPER_AWS_ACCESS_KEY"
-ENVNAME_AWS_SECRET_KEY = "SECRETKEEPER_AWS_SECRET_KEY"
-ENVNAME_AWS_REGION = "SECRETKEEPER_AWS_REGION"
-
-
-def _get_client():
-    access_key = os.environ[ENVNAME_AWS_ACCESS_KEY]
-    secret_key = os.environ[ENVNAME_AWS_SECRET_KEY]
-    region = os.environ[ENVNAME_AWS_REGION]
-
-    client = boto3.client(
-        'ssm',
-        region_name=region,
-        aws_access_key_id=access_key,
-        aws_secret_access_key=secret_key,
-    )
-    return client
-
-
-def tell(alias):
-    response = _get_client().get_parameter(
-        Name=alias, WithDecryption=True,
-    )
-    return response['Parameter']['Value']
-
-
-def tell_safe(alias):
-    try:
-        return tell(alias)
-    except Exception:
-        return None
-
-
-__all__ = ["tell", "tell_safe", "ENVNAME_AWS_ACCESS_KEY", "ENVNAME_AWS_SECRET_KEY", "ENVNAME_AWS_REGION"]
+from .config import *
+from .connect import *

ridi/secret_keeper/config.py

@@ -0,0 +1,31 @@
+import os
+
+from collections import namedtuple
+
+ENVNAME_AWS_ACCESS_KEY = "SECRETKEEPER_AWS_ACCESS_KEY"
+ENVNAME_AWS_SECRET_KEY = "SECRETKEEPER_AWS_SECRET_KEY"
+ENVNAME_AWS_REGION = "SECRETKEEPER_AWS_REGION"
+
+ConnectArgsType = namedtuple('ConnectArgsType', [
+    'aws_access_key', 'aws_secret_key', 'aws_region'
+])
+
+AWS_CONNECT_ARGS = None
+
+
+def configure(aws_access_key=None, aws_secret_key=None, aws_region=None):
+    global AWS_CONNECT_ARGS
+    AWS_CONNECT_ARGS = ConnectArgsType(
+        aws_access_key=aws_access_key,
+        aws_secret_key=aws_secret_key,
+        aws_region=aws_region,
+    )
+
+
+configure(
+    aws_access_key=os.environ.get(ENVNAME_AWS_ACCESS_KEY),
+    aws_secret_key=os.environ.get(ENVNAME_AWS_SECRET_KEY),
+    aws_region=os.environ.get(ENVNAME_AWS_REGION),
+)
+
+__all__ = ["configure", "ENVNAME_AWS_ACCESS_KEY", "ENVNAME_AWS_SECRET_KEY", "ENVNAME_AWS_REGION"]

ridi/secret_keeper/connect.py

@@ -0,0 +1,30 @@
+import boto3
+
+
+def _get_client():
+    from ridi.secret_keeper.config import AWS_CONNECT_ARGS
+
+    client = boto3.client(
+        'ssm',
+        region_name=AWS_CONNECT_ARGS.aws_region,
+        aws_access_key_id=AWS_CONNECT_ARGS.aws_access_key,
+        aws_secret_access_key=AWS_CONNECT_ARGS.aws_secret_key,
+    )
+    return client
+
+
+def tell(alias):
+    response = _get_client().get_parameter(
+        Name=alias, WithDecryption=True,
+    )
+    return response['Parameter']['Value']
+
+
+def tell_safe(alias):
+    try:
+        return tell(alias)
+    except Exception:
+        return None
+
+
+__all__ = ["tell", "tell_safe"]

setup.py

@@ -9,7 +9,7 @@
     packages=[
         'ridi.secret_keeper',
     ],
-    version='0.1.2',
+    version='0.2.0',
     description='Secret Keeper',
     url='/~https://github.com/ridi/secret-keeper-python',
     keywords=['secret', 'secret-keeper', 'ridi', 'ridibooks'],
@@ -20,4 +20,4 @@
     install_requires=[
         'boto3>=1.9.16',
     ],
-)
+)