Skip to content

katzrkool/B.LambdaLayerCommon

 
 

Repository files navigation

B.LambdaLayerCommon

Pipeline

A lambda layer resource that contains various useful methods.

Description

This is a simple lambda layer, that contains various useful methods that will make infrastructure development much easier. It also allows you to easily manage (add) additional external dependencies. Note, docker is used to build this code.

Remarks

Biomapas aims to modernise life-science industry by sharing its IT knowledge with other companies and the community. This is an open source library intended to be used by anyone. Improvements and pull requests are welcome.

Related technology

  • Python3
  • Docker
  • AWS CDK
  • AWS Lambda
  • AWS Lambda Layer

Assumptions

This project assumes you know what Lambda functions are and how code is being shared between them (Lambda layers).

  • Excellent knowledge in IaaC (Infrastructure as a Code) principles.
  • Excellent knowledge in Lambda functions and Lambda layers.
  • Good experience in AWS CDK and AWS CloudFormation.
  • Good Python skills and basis of OOP.

Useful sources

Install

Before installing this library, ensure you have these tools setup:

  • Python / Pip
  • AWS CDK
  • Docker

To install this project from source run:

pip install .

Or you can install it from a PyPi repository:

pip install b-lambda_layer_common

Usage & Examples

Main modules:

  • api_gateway
    Contains various functionalities related to API Gateway service and integrations.

  • cache
    Contains caching mechanisms for lambda functions.

  • events
    Contains functionality that supports event-driven architectures.

  • exceptions
    Contains advanced exception handling and propagation between lambda function chains.

  • ssm
    Contains SSM parameter store handling logic.

  • util
    Contains random fun stuff ;)

  • ws_api_gateway
    Contains various functionalities related to API Gateway websocket service and integrations.

Using this layer is extremely simple. Create it like this:

from aws_cdk.core import Stack, DockerImage
from b_lambda_layer_common.layer import Layer
from b_cfn_lambda_layer.package_version import PackageVersion

Layer(
    scope=Stack(),
    name='MyLayer',
    additional_pip_install_args='--pre',
    dependencies={
        'boto3': PackageVersion.from_string('1.16.35'),
    },
    docker_image=DockerImage.from_registry('python:3.9')
)

Or without any optional arguments:

from aws_cdk.core import Stack
from b_lambda_layer_common.layer import Layer

Layer(
    scope=Stack(),
    name='MyLayer',
)

Once you have deployed a lambda function with this layer, you can start using previously mentioned modules. For example, lets use an API-Gateway-formatted response:

from b_lambda_layer_common.api_gateway.response import Response

def handler(*args, **kwargs):
    return Response.json(
      http_status=200,
      body={
        'key': 'value'
      }
    )

Testing

This package has unit tests based on pytest. To run tests simply run:

pytest --cov=b_lambda_layer_common b_lambda_layer_common_test/unit --cov-fail-under=80

This package has integration tests based on pytest. To run tests simply run:

pytest b_lambda_layer_common_test/integration/tests

Contribution

Found a bug? Want to add or suggest a new feature? Contributions of any kind are gladly welcome. You may contact us directly, create a pull-request or an issue in github platform. Lets modernize the world together.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%