https://github.com/serverless/serverless-helpers-py

https://github.com/serverless/serverless-helpers-py

Last synced: 8 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/serverless/serverless-helpers-py
• Owner: serverless
• License: mit
• Created: 2016-02-17T17:17:10.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2016-03-29T17:12:50.000Z (over 9 years ago)
• Last Synced: 2025-04-18T07:51:30.691Z (8 months ago)
• Language: Python
• Size: 25.4 KB
• Stars: 11
• Watchers: 2
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
## serverless_helpers

[![serverless](http://public.serverless.com/badges/v3.svg)](http://www.serverless.com)

[![test status](https://api.travis-ci.org/serverless/serverless-helpers-py.svg)](https://travis-ci.org/serverless/serverless-helpers-py)

[![version](https://img.shields.io/pypi/v/serverless_helpers.svg)](https://pypi.python.org/pypi/serverless_helpers/)

[![downloads](https://img.shields.io/pypi/dm/serverless_helpers.svg)](https://pypi.python.org/pypi/serverless_helpers/)

[![license](https://img.shields.io/pypi/l/serverless_helpers.svg)](https://github.com/serverless/serverless-helpers-py/blob/master/LICENSE)

[![gitter](https://img.shields.io/gitter/room/serverless/serverless.svg)](https://gitter.im/serverless/serverless)

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

# This is optional if you are using serverless v0.5 or later, because it

# automatically loads variables without help

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/