Add sample config

Author: aaronfriedman6

README.md

@@ -14,7 +14,7 @@ This package contains common Python utility classes and functions.
 * Making requests to the Oauth2 authenticated APIs such as NYPL Platform API and Sierra
 
 ## Functions
-* Reading a YAML config file and putting the contents in os.environ
+* Reading a YAML config file and putting the contents in os.environ -- see `config/sample.yaml` for an example of how the config file should be formatted
 * Creating a logger in the appropriate format
 * Obfuscating a value using bcrypt
 * Parsing/building Research Catalog identifiers
@@ -57,8 +57,8 @@ When a new client or helper file is created, a new optional dependency set shoul
 
 The optional dependency sets also give the developer the option to manually list out the dependencies of the clients rather than relying upon what the package thinks is required, which can be beneficial in certain circumstances. For instance, AWS lambda functions come with `boto3` and `botocore` pre-installed, so it's not necessary to include these (rather hefty) dependencies in the lambda deployment package.
 
-### Troubleshooting
-#### Using PostgreSQLClient in an AWS Lambda
+## Troubleshooting
+### Using PostgreSQLClient in an AWS Lambda
 Because `psycopg` requires a statically linked version of the `libpq` library, the `PostgreSQLClient` cannot be installed as-is in an AWS Lambda function. Instead, it must be packaged as follows:
 ```bash
 pip install --target ./package nypl-py-utils[postgresql-client]==1.1.2
@@ -72,7 +72,7 @@ pip install \
     'psycopg[binary]'
 ```
 
-#### Using PostgreSQLClient locally
+### Using PostgreSQLClient locally
 If using the `PostgreSQLClient` produces the following error locally:
 ```
 ImportError: no pq wrapper available.

config/sample.yaml

@@ -0,0 +1,14 @@
+---
+PLAINTEXT_VARIABLES:
+    STRING_VAR: string-var
+    INT_VAR: 1
+    LIST_VAR:
+        - string-var2
+        - 2
+ENCRYPTED_VARIABLES:
+    ENCRYPTED_STRING_VAR: AQECAHh7ea2tyZ6phZgT4B9BDKwguhlFtRC6hgt+7HbmeFsrsgAAAGowaAYJKoZIhvcNAQcGoFswWQIBADBUBgkqhkiG9w0BBwEwHgYJYIZIAWUDBAEuMBEEDCvE8Pc8PiUEiCGpEAIBEIAnf8fz6YXH959A0ygrM4S95giFnwvp9dYFzp/2ViAIlD5GZ1S04vay
+    ENCRYPTED_INT_VAR: AQECAHh7ea2tyZ6phZgT4B9BDKwguhlFtRC6hgt+7HbmeFsrsgAAAF8wXQYJKoZIhvcNAQcGoFAwTgIBADBJBgkqhkiG9w0BBwEwHgYJYIZIAWUDBAEuMBEEDFQdg7ua7D8XH7UZGgIBEIAcpkIN6+56sbR3Vbk12NX2QDY28dnL8IWgVdnBRA==
+    ENCRYPTED_LIST_VAR:
+        - AQECAHh7ea2tyZ6phZgT4B9BDKwguhlFtRC6hgt+7HbmeFsrsgAAAGswaQYJKoZIhvcNAQcGoFwwWgIBADBVBgkqhkiG9w0BBwEwHgYJYIZIAWUDBAEuMBEEDMTe0jJyHxGaiy0PHQIBEIAo4+qpfJp/gfZqhl1GtN/q9ebn2isiVOn5QLK/fcUtWeG182jiKPdOFA==
+        - AQECAHh7ea2tyZ6phZgT4B9BDKwguhlFtRC6hgt+7HbmeFsrsgAAAF8wXQYJKoZIhvcNAQcGoFAwTgIBADBJBgkqhkiG9w0BBwEwHgYJYIZIAWUDBAEuMBEEDGsG/1m7nes884q8vQIBEIAc9eBDgUgVzVsK3lyebNmc09kGfP7Gzwm6ESJAiA==
+...

src/nypl_py_utils/functions/config_helper.py

@@ -16,12 +16,13 @@ def load_env_file(run_type, file_string):
     exported into os.environ as a json string and should be loaded as such.
 
     It requires the YAML file to be split into a 'PLAINTEXT_VARIABLES' section
-    and an 'ENCRYPTED_VARIABLES' section.
+    and an 'ENCRYPTED_VARIABLES' section. See config/sample.yaml for an example
+    config file.
 
     Parameters
         ----------
         run_type: str
-            The name of the config file to use, e.g. 'devel'
+            The name of the config file to use, e.g. 'sample'
         file_string: str
             The path to the config files with the filename as a variable to be
             interpolated, e.g. 'config/{}.yaml'