Handy dandy functions for python development using the Serverless framework
Project description
## serverless_helpers
This library isn't *required* for writing Python in the [serverless][sls], but
it does make your life easier by handling things like environment variables for
you.
## Usage
```
import serverless_helpers
# all .env files are loaded into the environment
serverless_helpers.load_envs(__file__)
# Loads stack outputs into environment variables as `SERVERLESS_CF_[output name]`
serverless_helpers.load_cfn_outputs()
import os
os.getenv('SERVERLESS_STAGE') # dev
# get role ARN from default serverless CloudFormation stack
os.getenv('SERVERLESS_CF_IamRoleArnLambda') # arn:aws:iam::123456789012:....
# alternate way to read roles
outputs = serverless_helpers.load_cfn_outputs()
outputs['IamRoleArnLambda'] # arn:aws:iam::123456789012:....
```
## License
This code is released under the MIT software license, see LICENSE file for
details. No warranty of any kind is included, and the copyright notice must be
included in redistributions.
*Notable exception*: `dotenv.py` is from
[python-dotenv](https://github.com/theskumar/python-dotenv) to remove
dependencies on click and ordereddict for performance/deployment size reasons.
Read the license contained in `dotenv.py` for details on its creators and
license conditions.
[sls]: http://serverless.com/
This library isn't *required* for writing Python in the [serverless][sls], but
it does make your life easier by handling things like environment variables for
you.
## Usage
```
import serverless_helpers
# all .env files are loaded into the environment
serverless_helpers.load_envs(__file__)
# Loads stack outputs into environment variables as `SERVERLESS_CF_[output name]`
serverless_helpers.load_cfn_outputs()
import os
os.getenv('SERVERLESS_STAGE') # dev
# get role ARN from default serverless CloudFormation stack
os.getenv('SERVERLESS_CF_IamRoleArnLambda') # arn:aws:iam::123456789012:....
# alternate way to read roles
outputs = serverless_helpers.load_cfn_outputs()
outputs['IamRoleArnLambda'] # arn:aws:iam::123456789012:....
```
## License
This code is released under the MIT software license, see LICENSE file for
details. No warranty of any kind is included, and the copyright notice must be
included in redistributions.
*Notable exception*: `dotenv.py` is from
[python-dotenv](https://github.com/theskumar/python-dotenv) to remove
dependencies on click and ordereddict for performance/deployment size reasons.
Read the license contained in `dotenv.py` for details on its creators and
license conditions.
[sls]: http://serverless.com/
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file serverless_helpers-0.3.1.tar.gz
.
File metadata
- Download URL: serverless_helpers-0.3.1.tar.gz
- Upload date:
- Size: 5.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ed11a85961f5006261d00237a3b30846d05b32445e7fd6de7dd70717a11879b3 |
|
MD5 | 1de48bdb782ff56fc0f2340eec8f6e97 |
|
BLAKE2b-256 | a0e5d4859f5baa70c15332acc48d2c61edb7d19df2f61cfeff4723e8c7af099d |