Skip to content

README Documentation Fixes #54

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nficano merged 3 commits into from
Jul 13, 2017
Merged

README Documentation Fixes #54

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c529986
Cleaning up the documentation now that the pull was done.
asaolabs Jul 12, 2017
9bcc5f0
Merge remote-tracking branch 'upstream/master'
asaolabs Jul 12, 2017
ec66aa6
Cleaned up some verbiage in the env. variables section
asaolabs Jul 13, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 2 additions & 15 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,6 @@ python-λ

Python-lambda is a toolset for developing and deploying *serverless* Python code in AWS Lambda.

NOTE: CHANGES FROM BASE REPOSITORY
==================================

* Adding Python 3.6 support for the local environment & the lambda runtime
* Supports "secret" environment variable values by reading them from the local environment during deploy instead of using hard-coded ones in the config file.
* You can install this version via pip with ``pip install --editable git+https://github.com/asaolabs/python-lambda#egg=python-lambda``


A call for contributors
=======================
With python-lambda and `pytube <https://github.com/nficano/pytube/>`_ both continuing to gain momentum, I'm calling for contributors to help build out new features, review pull requests, fix bugs, and maintain overall code quality. If you're interested, please email me at nficano[at]gmail.com.
Expand Down Expand Up @@ -161,19 +153,14 @@ Now try and run:

Environment Variables
=====================
Lambda functions support environment variables. In order to set environment variables for your deployed code to use, you can configure them in ``config.yaml``
Lambda functions support environment variables. In order to set environment variables for your deployed code to use, you can configure them in ``config.yaml``. To load the
value for the environment variable at the time of deployment (instead of hard coding them in your configuration file), you can use local environment values (see 'env3' in example code below).

.. code:: yaml

environment_variables:
env1: foo
env2: baz

You can also keep "secrets" out of your config file by using the following syntax ``${}`` to read the values from your current/local environment.

.. code:: yaml

environment_variables:
env3: ${LOCAL_ENVIRONMENT_VARIABLE_NAME}

This would create environment variables in the lambda instance upon deploy. If your functions don't need environment variables, simply leave this section out of your config.
Expand Down