0.12.0 release; add docstring to aws_lambda.deploy_function and add examples dir

Author: carlvitzthum

MANIFEST.in

@@ -3,7 +3,7 @@ include LICENSE
 include README.rst
 include requirements.txt
 include python/boto/endpoints.json
-]recursive-include tests *.json *.py *.txt *.yaml
+recursive-include tests *.json *.py *.txt *.yaml
 recursive-include templates *
 recursive-exclude * __pycache__
 recursive-exclude * *.py[co]

aws_lambda/_version.py

@@ -1,4 +1,4 @@
 """Version information."""
 
 # The following line *must* be the last in the module, exactly as formatted:
-__version__ = "0.12.0-beta6"
+__version__ = "0.12.0"

aws_lambda/aws_lambda.py

@@ -12,7 +12,6 @@
 
 
 log = logging.getLogger(__name__)
-log.setLevel(logging.INFO)
 
 
 def read_file(path, loader=None, binary_file=False):
@@ -25,6 +24,39 @@ def read_file(path, loader=None, binary_file=False):
 
 def deploy_function(function_module, function_name_suffix='', package_objects=None,
                     requirements_fpath=None, extra_config=None, local_package=None):
+    """
+    Creates or updates a lambda function given a `function_module` that is a
+    python module containing a dictionary config and correct handler function.
+    The name of the handler function must match the `function_handler` value
+    in the config.
+
+    Overall, this function creates a temporary directory and installs the lambda
+    service function, as well as supplied python modules and pip packages. This
+    directory is compressed as a temporary zip file and used to create/update
+    the lambda function.
+
+    Args:
+        function_module (types.ModuleType):
+            Python module containing the `config` dictionary and handler
+            function necessary to deploy the lambda function. See an examples
+            in aws_lambda.examples.
+        function_name_suffix (str):
+            If provided, will append the given string (with prepended "_" if
+            not present) to the deployed lambda function name.
+        package_objects (list):
+            Optional list of Python packages (types.ModuleType) that will be
+            explicitly added to the zipfile for lambda code. Use this argument
+            as an alternative to pip installing packages.
+        requirements_fpath (str): path to requirements.txt file to pip install.
+        extra_config (dict):
+            additional kwargs that will be passed to boto3 create_function
+            or update_function_configuration for lambda client. Optionally use
+            to override `Environment` or any other arguments.
+        local_package (str): optional path to a Python repo to pip install.
+
+    Returns:
+        None
+    """
     # check provided function module and packages
     cfg = function_module.config
     function_fpath = function_module.__file__

aws_lambda/examples/__init__.py

@@ -0,0 +1,31 @@
+"""
+Example lambda configuation file, including `config` dictionary and
+an example handler function.
+
+Would deploy with:
+```
+from aws_lambda import deploy_function
+from aws_lambda.examples import example_function
+deploy_function(example_function,
+                function_name_suffix=<optional str suffix>,
+                package_objects=<optional list of Python modules>,
+                requirements_fpath=<optional path to requirements file>,
+                extra_config=<optional dict for extra boto3 lambda kwargs>)
+```
+"""
+
+
+config = {
+    'function_name': 'my_test_function',
+    'function_module': 'service',
+    'function_handler': 'handler',
+    'handler': 'service.handler',
+    'region': 'us-east-1',
+    'runtime': 'python3.6',
+    'role': 'my_iam_role',
+    'description': 'Some description for my test lambda'
+}
+
+
+def handler(event, context):
+    return 'Hello! My input event is %s' % event